V1PaymentItemization

July 10, 2019 ยท View on GitHub

Description

Payment include an itemizations field that lists the items purchased, along with associated fees, modifiers, and discounts. Each itemization has an itemization_type field that indicates which of the following the itemization represents:

  • An item variation from the merchant's item library
  • A custom monetary amount
  • An action performed on a Square gift card, such as activating or reloading it.
Note*: itemization information included in a Payment object reflects details collected at the time of the payment. Details such as the name or price of items might have changed since the payment was processed.

Properties

NameTypeDescriptionNotes
nameStringThe item's name.[optional]
quantityBigDecimalThe quantity of the item purchased. This can be a decimal value.[optional]
itemizationTypeStringThe type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See V1PaymentItemizationItemizationType for possible values[optional]
itemDetailV1PaymentItemDetailDetails of the item, including its unique identifier and the identifier of the item variation purchased.[optional]
notesStringNotes entered by the merchant about the item at the time of payment, if any.[optional]
itemVariationNameStringThe name of the item variation purchased, if any.[optional]
totalMoneyV1MoneyThe total cost of the item, including all taxes and discounts.[optional]
singleQuantityMoneyV1MoneyThe cost of a single unit of this item.[optional]
grossSalesMoneyV1MoneyThe total cost of the itemization and its modifiers, not including taxes or discounts.[optional]
discountMoneyV1MoneyThe total of all discounts applied to the itemization. This value is always negative or zero.[optional]
netSalesMoneyV1MoneyThe sum of gross_sales_money and discount_money.[optional]
taxesList<V1PaymentTax>All taxes applied to this itemization.[optional]
discountsList<V1PaymentDiscount>All discounts applied to this itemization.[optional]
modifiersList<V1PaymentModifier>All modifier options applied to this itemization.[optional]