tenantExchangeRates

Requires at least one of the permissions settings:currency:read, settings:currency:update or settings:tenant:read.

Lists the organization's own dated exchange rates, and marks which are in force. Requires permission to read or update currency settings, or to read tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query TenantExchangeRates {
  tenantExchangeRates {
    baseCurrency
    pairs {
      fromCurrency
      globalRate
      globalRateAsOf
      globalRateSource
      toCurrency
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantExchangeRates {\n  tenantExchangeRates {\n    baseCurrency\n    pairs {\n      fromCurrency\n      globalRate\n      globalRateAsOf\n      globalRateSource\n      toCurrency\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "tenantExchangeRates": {
      "baseCurrency": "string",
      "pairs": [
        {
          "fromCurrency": "string",
          "globalRate": 0,
          "globalRateAsOf": "2025-01-15T00:00:00Z",
          "globalRateSource": "string",
          "toCurrency": "string"
        }
      ]
    }
  }
}

tenantExchangeRates: TenantExchangeRateSettings!

Type

TenantExchangeRateSettings object

The organization's exchange rate settings.