Item Object

Each item in a receipt is described in an item object, containing the following keys:

Name

Type

Description

return

Return Object, optional

see Return Object

name

string, required

the descriptive name for this item

name:tag

string, alternative

translations for name, where tag is a RFC5646 language tag using underscores instead of hyphens

quantity

number, required

the quantity of this item purchased

unit

string, optional

the quantity unit

total

float, required

the total price for this item

net

float, optional

the net price for this item

gross

float, optional

the gross price for this item

unit_price

float, optional

the unit price for this item

gross_unit_price

float, optional

the gross unit price for this item

net_unit_price

float, optional

the net unit price for this item

vat

VAT Object, optional

deprecated: use taxes instead

taxes

array of Tax Objects, optional

see Tax Object

discounts

array of Discount Objects, optional

see Discount Object

properties

Item Properties Object, optional

see Item Properties Object

Notes

  • All keys, except vat and discounts may contain the value null

  • Where multiple identical items are present, these may may either be listed as a single item with a quantity larger than one, or as multiple identical item objects with a quantity of one, or as a combination of the two, reflecting how the items are presented on the original receipt

  • name may or may not include information about discounts, price per item, price per meter, etc.

  • total, may or may not reflect any discounts which have been applied to this item

  • net, if present, may or may not have had discounts subtracted and there will be no indication of whether this is the case

  • vat is deprecated. Please use the items taxes property instead. Vat is left here for backwards compatibility.

  • taxes stores multiple tax objects for each instance of a receipt item.