API Docs
Retrieve currencies
Contents
This API returns a list of Currencies or a Currency and Exchange Rate.
Resource URL
GET /almaws/v1/acq/currencies
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
mode | xs:string | Optional. Default: ALL | The mode for currency display. May be ALL, Subset or Ratio. ALL by default. |
source_currency | xs:string | Required | Source currency ID. Applies only to Ratio mode and is optional. |
target_currency | xs:string | Required | Target currency ID. Applies only to Ratio mode and is optional. |
exchange_date | xs:string | Required | The exchange date. Applies only to Ratio mode and is required. Format YYYYMMDD |
Body Parameters
None
Output
This method returns a Currencies object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 40166410 | A currency parameter is not valid. |
| 401666 | A parameter is not valid. |
| 60348 | The exchange rate cannot be determined. |