setOrganizationBaseCurrency

Requires permission settings:tenant:update.

Set base currency (only before first transaction). Requires permission to update 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 SetOrganizationBaseCurrency($input: SetBaseCurrencyInput!) {
  setOrganizationBaseCurrency(input: $input)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetOrganizationBaseCurrency($input: SetBaseCurrencyInput!) {\n  setOrganizationBaseCurrency(input: $input)\n}",
  "variables": {
    "input": {
      "currencyCode": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "currencyCode": "string"
  }
}

Response:

{
  "data": {
    "setOrganizationBaseCurrency": true
  }
}

setOrganizationBaseCurrency(
  input: SetBaseCurrencyInput!
): Boolean!

Arguments

setOrganizationBaseCurrency.input ● SetBaseCurrencyInput! non-null input

The fields of the base currency to change.

Type

Boolean scalar

The Boolean scalar type represents true or false.