Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
27 lines (20 loc) · 2.62 KB

V1PaymentItemization.md

File metadata and controls

27 lines (20 loc) · 2.62 KB

V1PaymentItemization

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

Name Type Description Notes
name String The item's name. [optional]
quantity BigDecimal The quantity of the item purchased. This can be a decimal value. [optional]
itemizationType String The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See V1PaymentItemizationItemizationType for possible values [optional]
itemDetail V1PaymentItemDetail Details of the item, including its unique identifier and the identifier of the item variation purchased. [optional]
notes String Notes entered by the merchant about the item at the time of payment, if any. [optional]
itemVariationName String The name of the item variation purchased, if any. [optional]
totalMoney V1Money The total cost of the item, including all taxes and discounts. [optional]
singleQuantityMoney V1Money The cost of a single unit of this item. [optional]
grossSalesMoney V1Money The total cost of the itemization and its modifiers, not including taxes or discounts. [optional]
discountMoney V1Money The total of all discounts applied to the itemization. This value is always negative or zero. [optional]
netSalesMoney V1Money The sum of gross_sales_money and discount_money. [optional]
taxes List<V1PaymentTax> All taxes applied to this itemization. [optional]
discounts List<V1PaymentDiscount> All discounts applied to this itemization. [optional]
modifiers List<V1PaymentModifier> All modifier options applied to this itemization. [optional]