Item Object¶
Each item in a receipt is described in an item object, containing the following keys:
Name |
Type |
Description |
---|---|---|
|
Return Object, optional |
see Return Object |
|
string, required |
the descriptive name for this item |
|
string, alternative |
translations for |
|
number, required |
the quantity of this item purchased |
|
string, optional |
the quantity unit |
|
float, required |
the total price for this item |
|
float, optional |
the net price for this item |
|
float, optional |
the gross price for this item |
|
float, optional |
the unit price for this item |
|
float, optional |
the gross unit price for this item |
|
float, optional |
the net unit price for this item |
|
VAT Object, optional |
deprecated: use |
|
array of Tax Objects, optional |
see Tax Object |
|
array of Discount Objects, optional |
see Discount Object |
|
Item Properties Object, optional |
Notes¶
All keys, except
vat
anddiscounts
may contain the valuenull
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 itemnet
, if present, may or may not have had discounts subtracted and there will be no indication of whether this is the casevat
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.