Tax Positions-object "taxPositions" – RetailForce

This article discusses the tax positions object (“taxPositions”) within the document object.

A complete description of the RetailForce DOM (Document Object Model), as well as a description of the individual elements, can be found in the downloads section of the RetailForce website (Object model documentation.pdf) in the respective version directory.

The taxPositions object summarizes all VAT items of a document and totals them.

taxPositions object

The following taxPositions object contains sample data.

"taxPositions": [
  {
    "vatIdentification": 0,
    "vatLabel": "string",
    "vatPercent": 0,
    "vatPercent1": 0,
    "vatPercent2": 0,
    "vatAmount": 0,
    "vatAmount2": 0,
    "netAmount": 0,
    "grossAmount": 0,
    "netValue": 0,
    "grossValue": 0,
    "taxValue": 0,
    "caption": "string",
    "order": 0
  }
],

The taxPositions object contains the following information.

Information in the ‘Type’ column:

M ... required (“mandatory”)
M* ... required in certain countries or under certain conditions
R ... recommended
O ... optional

Element		Type	Description
taxPositions		R	Specify all VAT positions in the document. Either all or none VAT positions must be specified. To obtain the tax positions from the document (if this property has not been set), use GetTaxPositions(Document, Boolean). Note for Austria: We recommend using this array to transmit the tax items of a document to avoid rounding problems within the data capture protocol (“DEP7”).
	vatIdentification		ID identifier of the VAT rate of the VAT item Can be retrieved using GET /api/v1/information/client/{clientId}/getVatIdentification specifying the VAT rate of the respective country.
	vatLabel		Additional designation of the VAT rate in some countries (Serbia).
	vatPercent	O	Tax rate in percent of this VAT item.
	vatPercent1		Tax rate as a percentage of this VAT item (in this case VAT item 1)
	vatPercent2	O	Tax rate as a percentage of this VAT item (in this case VAT item 2)
	vatAmount		VAT amount of the VAT item
	vatAmount2	O	VAT amount of VAT item 2
	netAmount		Net amount (excl. VAT) of the VAT item
	grossAmount		Gross amount (including VAT) of the VAT item
	netValue	O	Net value of the VAT item.
	grossValue	O	Gross value of the VAT item.
	taxValue	O	Tax value of the VAT item.
	caption	O	Description of the VAT item.
	order	O	Order of VAT position.

taxPositions object

Related articles