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
}
}
}
'import requests
url = "https://clarus-api.com/api/tax_rates"
payload = { "data": {
"type": "tax_rates",
"attributes": {
"name": "Standard VAT",
"component_rate": 20
}
} }
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({
data: {type: 'tax_rates', attributes: {name: 'Standard VAT', component_rate: 20}}
})
};
fetch('https://clarus-api.com/api/tax_rates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "tax_rates",
"attributes": {
"name": "Standard VAT",
"component_name": "VAT",
"component_rate": 20,
"tax_type": "sales",
"default": false
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Tax Rates
Create a tax rate
Create a tax rate with a percentage component rate (0–100).
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
}
}
}
'import requests
url = "https://clarus-api.com/api/tax_rates"
payload = { "data": {
"type": "tax_rates",
"attributes": {
"name": "Standard VAT",
"component_rate": 20
}
} }
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({
data: {type: 'tax_rates', attributes: {name: 'Standard VAT', component_rate: 20}}
})
};
fetch('https://clarus-api.com/api/tax_rates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "tax_rates",
"attributes": {
"name": "Standard VAT",
"component_name": "VAT",
"component_rate": 20,
"tax_type": "sales",
"default": false
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "tax_rates",
"attributes": {
"name": "Standard VAT",
"component_rate": 20.0
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
name | Yes | Tax rate name |
component_rate | Yes | Percentage rate, 0–100 |
component_rate is fixed at creation — only name can be changed on update.Authorizations
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
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
Show child attributes
Show child attributes
Response
Tax rate created successfully
Show child attributes
Show child attributes

