Exchange Rates API (/exchange_rates)
Use the budget lines API to manage exchange rates for currencies your company uses to pay for goods.
Note:
The Exchange Rates API only supports the creation of one-way exchange rates. For example, if you make a call for EUR > USD, you'll have that rate populated in your Coupa instance, but the reverse rate (USD > EUR) won't be created. You need to make a separate call for USD > EUR.
The URL to access exchange rates is:
https://<instance>/api/exchangerates
See Integration Best Practices for more info.
Actions
The Exchange Rates API allows you to:
| Verb | Path | Action | Description |
|---|---|---|---|
| POST |
/api/exchange_rates
|
create | Create exchange rate |
| GET |
/api/exchange_rates
|
index | Query exchange rates |
| GET |
/api/exchange_rates/:id
|
show | Show exchange rate |
| PUT |
/api/exchange_rates/:id
|
update | Update exchange rate |
Elements
The following elements are available for the Exchange Rates API:
| Element | Description | Required Field? | Unique? | Allowable Value | Api_In Field? | Api_Out Field? | Data Type |
|---|---|---|---|---|---|---|---|
| created-at | Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ | yes | datetime | ||||
| created-by | User who created | yes | User | ||||
| from-currency | Source for Currency Code | yes | yes | yes | Currency | ||
| id | Coupa unique identifier | yes | integer | ||||
| rate | Exchange Rate | yes | yes | decimal | |||
| rate-date | Effective Date | yes | yes | yes | datetime | ||
| to-currency | Target for Currency Code | yes | yes | yes | Currency | ||
| updated-at | Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ | yes | datetime | ||||
| updated-by | User who updated | yes | User | ||||
Note:
- For large data set and performance optimization, always limit your result with some GET criteria.
- The reference object Currency and the respective currency code or ID must already exist in the system.