Skip to main content
POST
/
api
/
tax_rates
Create a tax rate
curl --request POST \
  --url https://clarus-api.com/api/tax_rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "tax_rates",
    "attributes": {
      "name": "Standard VAT",
      "component_rate": 20
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "tax_rates",
    "attributes": {
      "name": "Standard VAT",
      "component_name": "VAT",
      "component_rate": 20,
      "tax_type": "sales",
      "default": false
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "tax_rates",
    "attributes": {
      "name": "Standard VAT",
      "component_rate": 20.0
    }
  }
}

​
Key Fields

FieldRequiredDescription
nameYesTax rate name
component_rateYesPercentage rate, 0–100
Note: component_rate is fixed at creation — only name can be changed on update.

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
​
data
object
required

Response

Tax rate created successfully

​
data
object