endTenantExchangeRate

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

Ends an exchange rate of the organization from now on, without changing past documents. A rate that has not started yet is withdrawn instead, and a rate that has already ended is refused. Requires permission to update currency or 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

mutation EndTenantExchangeRate($input: EndTenantExchangeRateInput!) {
  endTenantExchangeRate(input: $input) {
    id
    status
    createdAt
    effectiveFrom
    effectiveTo
    fromCurrency
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation EndTenantExchangeRate($input: EndTenantExchangeRateInput!) {\n  endTenantExchangeRate(input: $input) {\n    id\n    status\n    createdAt\n    effectiveFrom\n    effectiveTo\n    fromCurrency\n  }\n}",
  "variables": {
    "input": {
      "id": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "id": "id"
  }
}

Response:

{
  "data": {
    "endTenantExchangeRate": {
      "id": "id",
      "status": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "effectiveFrom": "2025-01-15T00:00:00Z",
      "effectiveTo": "2025-01-15T00:00:00Z",
      "fromCurrency": "string"
    }
  }
}

endTenantExchangeRate(
  input: EndTenantExchangeRateInput!
): TenantExchangeRate!

Arguments

endTenantExchangeRate.input ● EndTenantExchangeRateInput! non-null input

The ID of the rate and an optional end date.

Type

TenantExchangeRate object

One of the organization's own dated exchange rates. The rate is an exact decimal string meaning 1 unit of the foreign currency equals the rate in the base currency.