baseCurrency

Requires an authenticated session.

Get base currency for current organization

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 BaseCurrency {
  baseCurrency {
    currencyCode
    currencyName
    currencyId
    isLocked
    symbol
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BaseCurrency {\n  baseCurrency {\n    currencyCode\n    currencyName\n    currencyId\n    isLocked\n    symbol\n  }\n}"
}
EOF

Response:

{
  "data": {
    "baseCurrency": {
      "currencyCode": "string",
      "currencyName": "string",
      "currencyId": "string",
      "isLocked": true,
      "symbol": "string"
    }
  }
}

baseCurrency: BaseCurrencyInfo

Type

BaseCurrencyInfo object

The organization's base currency.