Retrieve the list of VAT rates (or sales tax / GST / etc. rates, depending on what taxation is used in the particular country).
To create a new tax rate, see saveVatRate.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| id | Fetch one tax rate by ID. | integer | |
| lang | Retrieve item names in a specific language. If omitted, API will return item names in the default language of your Erply account. Possible values:
|
string | |
| orderBy | 'id', 'name', 'active' or 'order' (default sorting order). | string | |
| orderByDir | Sort direction: 'asc' (ascending order) or 'desc' (descending order). By default, items are sorted in descending order. | string | |
| active | 0 for archived taxes, 1 for active taxes | integer | |
| recordsOnPage | Number of records API should return. By default 20, at most 1000. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer | |
| searchAttributeName | Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. | string | |
| searchAttributeValue | Attribute value to search for. Error 1030 will be returned if value is an array. | string |
| Field name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | integer | |||||||||||||||||||
| name | string | For displaying purposes. If rate = 20, then name may be "20%", for example. | ||||||||||||||||||
| rate | Decimal | |||||||||||||||||||
| code | string | Corresponding VAT code in accounting software. | ||||||||||||||||||
| active | integer | 0 for archived taxes, 1 for active taxes. | ||||||||||||||||||
| isReverseVat | integer | 0 for regular taxes, 1 for reverse taxes. Reverse VAT is a concept used in Europe. It means that in certain cases, the obligation to pay VAT (value-added tax) lies on the buyer, not the seller. A seller can issue an invoice where one or multiple lines are subject to reverse VAT. This amount of VAT must then be paid by the buyer directly to the Tax Department, and this VAT amount is not included in the total sum payable to the seller. The rate of a reverse VAT can be found from the field |
||||||||||||||||||
| reverseRate | number | The rate of a reverse VAT. A tax can only have |
||||||||||||||||||
| gstExemptTaxRateID | integer | Specific field for Canada and US, contains ID of corresponding reduced tax rate. | ||||||||||||||||||
| attributes | array | Additional attributes. Each item looks like this:
|
||||||||||||||||||
| ZIPCode | string | ZIP code signifying the area where this tax rate is used (if you have defined it when creating the tax rate). Available only if "City, county and state tax rates" module is enabled on your account. | ||||||||||||||||||
| category | string | Category of this tax rate (generally not used). Available only if "City, county and state tax rates" module is enabled on your account. | ||||||||||||||||||
| state | string | State name. Available only if "City, county and state tax rates" module is enabled on your account. | ||||||||||||||||||
| county | string | County name. Available only if "City, county and state tax rates" module is enabled on your account. | ||||||||||||||||||
| city | string | City name. Available only if "City, county and state tax rates" module is enabled on your account. | ||||||||||||||||||
| components | array | Available only if "City, county and state tax rates" module is enabled on your account. For each component, the following information is provided:
|