Search

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 nameDescriptionPossible valueRequired
langRetrieve 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'asc' (ascending) or 'desc' (descending). By default 'desc'String
active0 for archived taxes, 1 for active taxesInteger
recordsOnPageNumber of records API should return. By default 20, at most 1000.Integer
pageNoAPI 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
searchAttributeNameSearch from attribute name. searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString

Response

Field nameTypeDescription
idInteger
nameStringFor displaying purposes. If rate = 20, then name may be "20%", for example.
rateDecimal
codeStringCorresponding VAT code in accounting software.
activeInteger0 for archived taxes, 1 for active taxes.
isReverseVatInteger

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.

reverseRateDecimal

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.

gstExemptTaxRateIDIntegerCanada-specific field, contains ID of corresponding reduced tax rate, for GST-exempt customers.
attributesArrayAdditional 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.
ZIPCodeStringZIP code signifying the area where this tax rate is used (if you have defined it when creating the tax rate).
categoryStringCategory of this tax rate (generally not used).
stateStringState name.
countyStringCounty name.
cityStringCity name.
componentsArrayAvailable 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.