V1PaymentItemization
March 13, 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.
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 | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| name | getName() | setName($value) | string | The item's name. | [optional] |
| quantity | getQuantity() | setQuantity($value) | float | The quantity of the item purchased. This can be a decimal value. | [optional] |
| itemization_type | getItemizationType() | setItemizationType($value) | string | The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See V1PaymentItemizationItemizationType for possible values | [optional] |
| item_detail | getItemDetail() | setItemDetail($value) | \SquareConnect\Model\V1PaymentItemDetail | Details of the item, including its unique identifier and the identifier of the item variation purchased. | [optional] |
| notes | getNotes() | setNotes($value) | string | Notes entered by the merchant about the item at the time of payment, if any. | [optional] |
| item_variation_name | getItemVariationName() | setItemVariationName($value) | string | The name of the item variation purchased, if any. | [optional] |
| total_money | getTotalMoney() | setTotalMoney($value) | \SquareConnect\Model\V1Money | The total cost of the item, including all taxes and discounts. | [optional] |
| single_quantity_money | getSingleQuantityMoney() | setSingleQuantityMoney($value) | \SquareConnect\Model\V1Money | The cost of a single unit of this item. | [optional] |
| gross_sales_money | getGrossSalesMoney() | setGrossSalesMoney($value) | \SquareConnect\Model\V1Money | The total cost of the itemization and its modifiers, not including taxes or discounts. | [optional] |
| discount_money | getDiscountMoney() | setDiscountMoney($value) | \SquareConnect\Model\V1Money | The total of all discounts applied to the itemization. This value is always negative or zero. | [optional] |
| net_sales_money | getNetSalesMoney() | setNetSalesMoney($value) | \SquareConnect\Model\V1Money | The sum of gross_sales_money and discount_money. | [optional] |
| taxes | getTaxes() | setTaxes($value) | \SquareConnect\Model\V1PaymentTax[] | All taxes applied to this itemization. | [optional] |
| discounts | getDiscounts() | setDiscounts($value) | \SquareConnect\Model\V1PaymentDiscount[] | All discounts applied to this itemization. | [optional] |
| modifiers | getModifiers() | setModifiers($value) | \SquareConnect\Model\V1PaymentModifier[] | All modifier options applied to this itemization. | [optional] |
Note: All properties are protected and only accessed via getters and setters.