A tax rate that can be applied to line items in an invoice.
A unique Id for the tax rate.
The date/time the tax rate was created.
A description of the tax rate (e.g. VAT).
The date/time the tax rate was modified.
The rate of tax as a percentage, e.g. 17.5.
A unique tax code.
{
"_id": "66bfb4bb9ab4e3d6eb73481a",
"created": "2024-08-16 20:21:15",
"description": "Standard rate VAT",
"modified": "2024-08-16 20:21:15",
"rate": 20.0,
"tax_code": "STANDARD"
}
Return a list of tax rates setup for your account on CareHQ.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A case insensitive keyword filter applied to the following fields; description, tax_code.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of tax rates.
var taxRates = apiClient.Request(
HttpMethod.Get,
"tax-rates",
new MultiValueDict()
.Add("attributes", "description", "rate")
);
<?php
$tax_rates = $api_client->request(
'GET',
'tax-rates',
[
'attributes'=>[
'description',
'rate'
]
]
);
tax_rates = api_client(
'GET',
'tax-rates',
params={
'attributes': [
'description',
'rate'
]
}
)
tax_rates = api_client.request(
'GET',
'tax-rates',
params: {
'attributes' => [
'description',
'rate'
]
}
)
{
"item_count": 3,
"items": [
{
"_id": "66bfb4bb9ab4e3d6eb734818",
"description": "Reduced rate VAT",
"rate": 5.0
},
{
"_id": "66bfb4bb9ab4e3d6eb73481a",
"description": "Standard rate VAT",
"rate": 20.0
},
{
"_id": "66bfb4bb9ab4e3d6eb73481c",
"description": "Zero rate VAT",
"rate": 0.0
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var taxRate = apiClient.Request(HttpMethod.Get, $"tax-rates/{taxRateId}");
<?php
$tax_rate = $api_client->request('GET', 'tax-rates/' . $tax_rate_id);
tax_rate = api_client('GET', f'tax-rates/{tax_rate_id}')
tax_rate = api_client.request('GET', "tax-rates/#{tax_rate_id}")
{
"_id": "66bfb4bb9ab4e3d6eb73481a",
"created": "2024-08-16 20:21:15",
"description": "Standard rate VAT",
"modified": "2024-08-16 20:21:15",
"rate": 20.0,
"tax_code": "STANDARD"
}