getVatRates

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.

Input parameters

Parameter name Description Possible value Required
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:
  • 'eng' - English
  • 'spa' - Spanish
  • 'ger' - German
  • 'swe' - Swedish
  • 'fin' - Finnish
  • 'rus' - Russian
  • 'est' - Estonian
  • 'lat' - Latvian
  • 'lit' - Lithuanian
  • 'gre' - Greek
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 retrive 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

Response

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.

reverseRate Decimal

The rate of a reverse VAT.

A tax can only have reverseRate (if it is Reverse VAT) or rate (if it is a regular tax), but not both at the same time.

gstExemptTaxRateID Integer Canada-specific field, contains ID of corresponding reduced tax rate, for GST-exempt customers.
attributes Array Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value
*** *** All the following fields are available only if "City, county and state tax rates" module is enabled on your account.
ZIPCode String ZIP code signifying the area where this tax rate is used (if you have defined it when creating the tax rate).
category String Category of this tax rate (generally not used).
state String State name.
county String County name.
city String City name.
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:
Field nameTypeDescription
componentIDInteger
typeStringPossible types are:
  • STATE
  • COUNTY
  • CITY
  • OTHER
nameStringName for displaying purposes.
rateDecimalTax percentage.