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.
reports:readGrant 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
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.