Tax Fields - Venddor API

Tax Object Fields

A tax object has a number of properties, represented by fields. These fields control how taxes are calculated, displayed, and applied to products and orders.

Important: The table below shows all supported fields for tax objects. Mandatory fields are marked with *. Any field not listed below will be ignored if included in an API request.

Tax Field Reference

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.

Example Tax Object

{
  "tax": "Sales Tax",
  "tax_id": 12,
  "regnumber": 987654,
  "priority": 10,
  "price_includes_tax": "N",
  "display_including_tax": "Y",
  "address_type": "S",
  "status": "A",
  "lang_code": "EN"
}

Tip: When creating a new tax, only the tax field is required. Other fields will use their default values if not specified.

Note on Tax Priority: When multiple taxes apply to a product, they are calculated in order of priority (higher numbers are processed first). This is important when using compound tax calculations.