Taxes

URLs

Fields

A tax object has a number of properties, represented by fields.

The full list of supported fields is given below (mandatory fields are marked with *).

Note

Any field not listed in the table below will be ignored if occurs in an API request JSON data.

Field name Description Default value Supported values
tax* Tax name — string
tax_id* Tax ID Set automatically integer
regnumber Registration number — integer
priority Tax priority 0 positive integer
price_includes_tax
If Y, the tax will be included in product price,
if N, the tax value will be added to product price
 N
Y
N
display_including_tax Include the tax in product price N
Y
N
address_type
If S, the tax rates will depend on shipping address,
if B, the tax rates will depend on billing address
 S
S
B
status
Tax status:
A for Active,
D for Disabled,
H for Hidden
 A
A
D
H
lang_code Language code for the tax name The language code of the default store language
EN
RU
etc.