Kantata Kantata OX Knowledge Base Release Notes Status Page

Currencies

Get a list of currencies

Returns all currencies supported by Kantata OX, unless filter parameters have been applied.

Request
query Parameters
addable_to_rate_card_set_version
integer <int32>

Filters for currencies that can be added to the rate card associated with the specified Rate Card Set Version ID. If the associated rate card is the account default, all currencies supported by Kantata OX are returned.

If the associated rate card is not set as the account default, results are additionally limited to currencies on the account default rate card.

matching
string

Filters for currencies that approximately match the specified value. Valid values are ISO codes, names, or symbols of currencies supported by Kantata OX.

Responses
200

A list of objects have been retrieved.

Response Schema: application/json
iso_code
string

ISO alphabetic code (for example, USD).

name
string

Name of currency (for example, United States Dollar).

symbol
string

Symbol associated with currency (for example, $).

subunit_to_unit
integer <int32>

Number of subunits in one unit for currency.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/currencies
Request samples
Response samples
application/json
{
  • "iso_code": "string",
  • "name": "string",
  • "symbol": "string",
  • "subunit_to_unit": 0
}