Skip to main content
An exchange rate tells you how many units of one currency equal one unit of another on a given date. Numeral uses daily rates to report transactions collected in different currencies in a single currency.Supported currencies are the same as customer_currency_code on calculations. See Currencies.The endpoint works with any X-API-Version, or none.

The Exchange rate object

Attributes

string, value is "tax.exchange_rate"
String representing the object’s type.
string
The date of the rate, YYYY-MM-DD (UTC).
string
ISO 4217 code of the currency converted from, in uppercase.
string
ISO 4217 code of the currency converted to, in uppercase.
number
Units of target_currency per 1 unit of base_currency. Not rounded. 1 when both currencies are the same.
For weekends and market holidays, the rate is from the most recent trading day.
The Exchange rate object

Retrieve an exchange rate

Returns the rate between two currencies on a date. Try it in the API reference.

Parameters

string
required
The date, YYYY-MM-DD (UTC). Can’t be later than today in UTC.
string
required
ISO 4217 code of the currency to convert from, e.g. USD. Case-insensitive.
string
required
ISO 4217 code of the currency to convert to, e.g. EUR. Case-insensitive.
Any other query parameter returns UNRECOGNIZED_FIELD.

Returns

An Exchange rate object. Currency codes come back in uppercase, whatever case you sent.
GET /tax/exchange_rates
Response
Lowercase codes
Lowercase response

Errors

Errors return code, type, and message. Handle them by type. Full list in Error Codes.Checks run in the order below. If a request has more than one error, only the first is returned.