1.4 Items

Analog to Orders. within Invoices it is also necessary to determine and state the items information, focusing on the price information of a specific item.

Therefore, within invoices it is necessary to state the following fields:

Items

  • Discounts

    • The discount applied to the specific product.

  • Freegoods

    • This flag states if the item is a freegood or a redeemable product, it this flag is set as true, then it will not count towards earning points based on that purchase.

  • Price

    • The price of a single product.

  • Quantity

    • The quantity of the products purchased.

  • Subtotal

    • The subtotal of the product, taking into consideration the quantity of the products purchased but not accounting discounts, nor taxes.

  • Tax

    • The taxes embedded into the pricing of the product and multiplied by the quantity of products purchased.

  • Total

    • The total of the order including all taxes, discounts, and price of products as well as the quantity.

  • VendoritemId

    • The unique identifier of the product.

Property

Description

Required

Example

items

Invoice items.

true

 

items.[].discount

The item discount.

true

0

items.[].price

The item price.

true

34.00

items.[].quantity

The item quantity.

true

100

items.[].subtotal

The item subtotal.

true

3400.00

items.[].tax

The item tax total amount.

true

20.49

items.[].taxes

The invoice taxes

false

[ { "taxAmount": 16.84, "taxId": "COFINS" }, { "taxAmount": 3.65, "taxId": "PIS" } ]

items.[].total

The item total amount.

true

3420.49

items.[].vendorItemId

Item id from vendor.

true

"1234567890"