Tax rates
List all available tax rates for the administration
Returns a paginated list of all available tax rates for the administration
The filter
argument allows you to filter the list of tax rates. Filters are a combination of keys and values,
separated by a comma: percentage:21,tax_rate_type:sales_invoice
. The available options for filtering are:
Filter | Type | Default | Description |
name | String |
Select tax rates by their full name | |
partial_name | String |
Select tax rates with this substring in their name | |
percentage | Integer |
Select tax rates with the specified percentage, e.g. specify 21 for 21% |
|
tax_rate_type | String |
all |
all , general_journal_document , purchase_invoice or sales_invoice |
country | String |
Select tax rates with the specified country. Must be a 2 letter abbreviation following ISO 3166. Please note that only foreign tax rates will have this field set. Domestic tax rates will not have this set at the moment. | |
show_tax | Boolean |
Use true to tax rates for which tax is shown on the invoice, false for when it’s not shown. No value will select both |
|
active | Boolean |
Use true to select active tax rates. Use false for inactive tax rates. No value will select both |
|
created_after | String |
Tax rates created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone | |
updated_after | String |
Tax rates updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |
You can filter by multiple tax rate types at the same time as well. To do this, separate the state values by a pipe: state:purchase_invoice|sales_invoice
.
Parameters
Parameter | Type | Description |
---|---|---|
filter |
String |
Example: returns all tax rates of an administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?
Response
Status: 200 OK
[
{
"id": "395773789095331758",
"administration_id": 123,
"name": "21% btw",
"percentage": "21.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.486Z",
"updated_at": "2023-08-10T09:21:59.486Z"
},
{
"id": "395773789097428911",
"administration_id": 123,
"name": "9% btw",
"percentage": "9.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.489Z",
"updated_at": "2023-08-10T09:21:59.489Z"
},
{
"id": "395773789099526064",
"administration_id": 123,
"name": "0% btw",
"percentage": "0.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.491Z",
"updated_at": "2023-08-10T09:21:59.491Z"
}
]
Example: returns all tax rates filtered on percentage
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?filter=percentage%3A21
Response
Status: 200 OK
[
{
"id": "395773789095331758",
"administration_id": 123,
"name": "21% btw",
"percentage": "21.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.486Z",
"updated_at": "2023-08-10T09:21:59.486Z"
},
{
"id": "395773789101623217",
"administration_id": 123,
"name": "21% btw",
"percentage": "21.0",
"tax_rate_type": "purchase_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.493Z",
"updated_at": "2023-08-10T09:21:59.493Z"
}
]
Example: returns paginated tax rates on page 1
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?per_page=1
Response
Status: 200 OK
[
{
"id": "395773789095331758",
"administration_id": 123,
"name": "21% btw",
"percentage": "21.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.486Z",
"updated_at": "2023-08-10T09:21:59.486Z"
}
]
Example: returns paginated tax rates on page 2
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?page=2&per_page=1
Response
Status: 200 OK
[
{
"id": "395773789097428911",
"administration_id": 123,
"name": "9% btw",
"percentage": "9.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.489Z",
"updated_at": "2023-08-10T09:21:59.489Z"
}
]
Example: returns an error when too many tax rates are requested
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?per_page=20001
Response
Status: 400 Bad Request
{
"error": "Per Page is too big",
"symbolic": {
"per_page": "max"
}
}
Example: returns all tax rates created after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?filter=created_after%3A2023-08-09+09%3A25%3A30+UTC
Response
Status: 200 OK
[
{
"id": "395773789095331758",
"administration_id": 123,
"name": "21% btw",
"percentage": "21.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.486Z",
"updated_at": "2023-08-10T09:21:59.486Z"
},
{
"id": "395773789097428911",
"administration_id": 123,
"name": "9% btw",
"percentage": "9.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.489Z",
"updated_at": "2023-08-10T09:21:59.489Z"
},
{
"id": "395773789099526064",
"administration_id": 123,
"name": "0% btw",
"percentage": "0.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.491Z",
"updated_at": "2023-08-10T09:21:59.491Z"
}
]
Example: returns only tax rates updated after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/tax_rates.json?filter=updated_after%3A2023-08-10+09%3A25%3A35+UTC
Response
Status: 200 OK
[
{
"id": "395773789095331758",
"administration_id": 123,
"name": "foo",
"percentage": "21.0",
"tax_rate_type": "sales_invoice",
"show_tax": true,
"active": true,
"country": null,
"created_at": "2023-08-10T09:21:59.486Z",
"updated_at": "2023-08-10T09:26:35.626Z"
}
]