taxGroups

Requires an authenticated session.

Lists the organization's tax groups with their rates, optionally filtered and paged. Use taxGroupsCount for the total.

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 TaxGroups {
  taxGroups {
    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 TaxGroups {\n  taxGroups {\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}"
}
EOF

Response:

{
  "data": {
    "taxGroups": [
      {
        "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"
          }
        ]
      }
    ]
  }
}

taxGroups(
  filters: TaxGroupFiltersInput
  skip: Int
  take: Int
): [TaxGroup!]!

Arguments

taxGroups.filters ● TaxGroupFiltersInput input

Optional filters: sort, search text and active status.

taxGroups.skip ● Int scalar

How many tax groups to skip.

taxGroups.take ● Int scalar

How many tax groups to return.

Type

TaxGroup object

A set of tax rates applied together.