Skip to main content
POST
/
graphql#ListTaxRates
List tax rates
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListTaxRates' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: TaxRateFilterType) { tax_rates { all(filter: $filter) { edges { node { id name component_name component_rate tax_type default } } } } }"
}
'
{
  "data": {
    "tax_rates": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "name": "Standard VAT",
              "component_name": "VAT",
              "component_rate": 20,
              "tax_type": "sales",
              "default": true
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: TaxRateFilterType) {
  tax_rates {
    all(filter: $filter) {
      edges {
        node {
          id
          name
          component_name
          component_rate
          tax_type
          default
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between): 
{
  "filter": {
    "id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
idIdInputTypeeq, in, gt, gteq, lt, lteq, filledTax rate ID
nameStringInputTypeeq, ilike, like, in, betweenTax rate name
component_nameStringInputTypeeq, ilike, like, in, betweenTax component name
component_rateDecimalInputTypeeq, gt, gteq, lt, lteq, betweenTax percentage rate
tax_typeTaxTypeInputTypeeq, inTax type (enum input — sales, purchases)
defaultBooleanInputTypeeqWhether this is the default tax rate
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: TaxRateFilterType) { tax_rates { all(filter: $filter) { edges { node { id name component_name component_rate tax_type default } } } } }"

​
variables
object

Query variables including the filter object

Example:
{ "filter": { "name": { "ilike": "VAT" } } }

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any