taxRates

Requires an authenticated session.

Lists the organization's tax rates, optionally filtered and paged. Use taxRatesCount 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 TaxRates {
  taxRates {
    id
    code
    postalCode
    name
    groupName
    type
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TaxRates {\n  taxRates {\n    id\n    code\n    postalCode\n    name\n    groupName\n    type\n  }\n}"
}
EOF

Response:

{
  "data": {
    "taxRates": [
      {
        "id": "id",
        "code": "string",
        "postalCode": "string",
        "name": "string",
        "groupName": "string",
        "type": "string"
      }
    ]
  }
}

taxRates(
  filters: TaxRateFiltersInput
  skip: Int
  take: Int
): [TaxRate!]!

Arguments

taxRates.filters ● TaxRateFiltersInput input

Optional filters: sort, country, state, city, type, active, default and search text.

taxRates.skip ● Int scalar

How many tax rates to skip.

taxRates.take ● Int scalar

How many tax rates to return.

Type

TaxRate object

A tax rate.