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|
|lang||Retrieve item names in a specific language. If omitted, API will return item names in the default language of your ERPLY account.
|orderBy||'id', 'name', 'active' or 'order' (default sorting order).||String|
|orderByDir||'asc' (ascending) or 'desc' (descending). By default 'desc'||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||Search from attribute name. searchAttributeName and searchAttributeValue have to be specified both||String|
|searchAttributeValue||Search from attribute value||String|
|name||String||For displaying purposes. If rate = 20, then name may be "20%", for example.|
|code||String||Corresponding VAT code in accounting software.|
|active||Integer||0 for archived taxes, 1 for active taxes.|
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
The rate of a reverse VAT.
A tax can only have
|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:
|***||***||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).|
|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: