List tax types

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListTaxTypes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListTaxTypes"

payload = { "query": "query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: 'query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListTaxTypes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "tax_types": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "VAT20",
              "description": "Standard rated VAT",
              "rate": 20
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

POST

graphql#ListTaxTypes

List tax types

curl --request POST \
  --url 'https://clarus-api.com/graphql#ListTaxTypes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }"
}
'

import requests

url = "https://clarus-api.com/graphql#ListTaxTypes"

payload = { "query": "query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }" }
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: 'query($filter: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }'
  })
};

fetch('https://clarus-api.com/graphql#ListTaxTypes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "tax_types": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1",
              "code": "VAT20",
              "description": "Standard rated VAT",
              "rate": 20
            }
          }
        ]
      }
    }
  }
}

{
  "error": "<string>"
}

Query Structure

query($filter: TaxTypeFilterType) {
  tax_types {
    all(filter: $filter) {
      edges {
        node {
          id
          code
          description
          rate
        }
      }
    }
  }
}

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": {
    "code": {
      "ilike": "value"
    }
  }
}

Available Filters

Filter	Input Type	Operators	Description
`code`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Tax type code
`description`	StringInputType	`eq`, `ilike`, `like`, `in`, `between`	Tax type description
`rate`	DecimalInputType	`eq`, `gt`, `gteq`, `lt`, `lteq`, `between`	Tax rate percentage
`created_at`	DatetimeInputType	`eq`, `from`, `to`, `between`	Creation timestamp

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.

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/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: TaxTypeFilterType) { tax_types { all(filter: $filter) { edges { node { id code description rate } } } } }"

variables

object

Query variables including the filter object

Show child attributes

Example:

{ "filter": { "code": { "ilike": "VAT" } } }

Response

Successful GraphQL response

data

object

Query result data

Show child attributes

errors

object[]

GraphQL errors, if any

​Query Structure

​Filter Argument

​Available Filters

Authorizations

Body

Response

Query Structure

Filter Argument

Available Filters