Skip to main content

Get Report Display Currency Rate

GET 

/api/reporting/display-currency-rate

Returns the single rate that converts amounts in the account's base currency into another currency for a report window, so financial reports can be viewed in that currency. Presentation only: nothing is stored or posted in the display currency.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The rate is the average of the daily exchange rates inside the window (source: daily_average). If no daily rates fall inside it, the latest earlier daily rate is used (latest_available); with no daily rates at all, the rate stored on the currency is used (tenant_rate). Asking for the base currency returns a rate of 1 (source: base).

Multiply a base-currency amount by rate to get the display-currency amount.

Authentication: Requires Bearer token

Request​

Responses​

OK

Response Headers
    Content-Type