Square.Connect.Model.OrderReturnLineItem
October 23, 2019 ยท View on GitHub
Description
The line item being returned in an Order. Note: This model is in beta.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| Uid | string | Unique identifier for this return line item entry. | [optional] |
| SourceLineItemUid | string | `uid` of the LineItem in the original sale Order. | [optional] |
| Name | string | The name of the line item. | [optional] |
| Quantity | string | The quantity returned, formatted as a decimal number. For example: `"3"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `"1.70000"`. | |
| QuantityUnit | OrderQuantityUnit | The unit and precision that this return line item's quantity is measured in. | [optional] |
| Note | string | The note of the returned line item. | [optional] |
| CatalogObjectId | string | The `CatalogItemVariation` id applied to this returned line item. | [optional] |
| VariationName | string | The name of the variation applied to this returned line item. | [optional] |
| ReturnModifiers | List<OrderReturnLineItemModifier> | The `CatalogModifier`s applied to this line item. | [optional] |
| ReturnTaxes | List<OrderReturnTax> | A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any return-level taxes apportioned to this item. This field has been deprecated in favour of `applied_taxes`. | [optional] [deprecated] |
| ReturnDiscounts | List<OrderReturnDiscount> | A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any return-level discounts apportioned to this item. This field has been deprecated in favour of `applied_discounts`. | [optional] [deprecated] |
| AppliedTaxes | List<OrderLineItemAppliedTax> | The list of references to `OrderReturnTax` entities applied to the returned line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the returned line item. On reads, the amount applied is populated. | [optional] |
| AppliedDiscounts | List<OrderLineItemAppliedDiscount> | The list of references to `OrderReturnDiscount` entities applied to the returned line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the returned line item. On reads, the amount applied is populated. | [optional] |
| BasePriceMoney | Money | The base price for a single unit of the line item. | [optional] |
| VariationTotalPriceMoney | Money | The total price of all item variations returned in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers. | [optional] |
| GrossReturnMoney | Money | The gross return amount of money calculated as (item base price + modifiers price) * quantity. | [optional] |
| TotalTaxMoney | Money | The total tax amount of money to return for the line item. | [optional] |
| TotalDiscountMoney | Money | The total discount amount of money to return for the line item. | [optional] |
| TotalMoney | Money | The total amount of money to return for this line item. | [optional] |