Tax rates are the VAT tariffs that apply to your products and services.
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringpageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$
Responses
A list of tax rates
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
namestringpercentagetax_rate_typestring · enumEnum values:sales_invoicepurchase_invoicegeneral_journal_documentshow_taxboolean | nullactiveboolean | nullcountrystring | nullcreated_atstring | null · date-timeupdated_atstring | null · date-time