taxGroup

Requires an authenticated session.

Returns one tax group with its rates. Fails if it does not exist.

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 TaxGroup($id: ID!) {
  taxGroup(id: $id) {
    id
    code
    name
    createdAt
    calculationMethod
    description
    taxRates {
      id
      createdAt
      taxGroupId
      taxRateId
      updatedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TaxGroup($id: ID!) {\n  taxGroup(id: $id) {\n    id\n    code\n    name\n    createdAt\n    calculationMethod\n    description\n    taxRates {\n      id\n      createdAt\n      taxGroupId\n      taxRateId\n      updatedAt\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "taxGroup": {
      "id": "id",
      "code": "string",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "calculationMethod": "string",
      "description": "string",
      "taxRates": [
        {
          "id": "id",
          "createdAt": "2025-01-15T00:00:00Z",
          "taxGroupId": "string",
          "taxRateId": "string",
          "updatedAt": "2025-01-15T00:00:00Z"
        }
      ]
    }
  }
}

taxGroup(
  id: ID!
): TaxGroup!

Arguments

taxGroup.id ● ID! non-null scalar

The ID of the tax group.

Type

TaxGroup object

A set of tax rates applied together.