OrderReturnLineItem
June 12, 2019 ยท View on GitHub
squareconnect.models.order_return_line_item
Description
The line item being returned in an Order.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| uid | str | Unique identifier for this return line item entry. This is a read-only field. | [optional] |
| source_line_item_uid | str | `uid` of the LineItem in the original sale Order. | [optional] |
| name | str | The name of the line item. | [optional] |
| quantity | str | 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"`. | |
| quantity_unit | OrderQuantityUnit | The unit and precision that this return line item's quantity is measured in. | [optional] |
| note | str | The note of the returned line item. | [optional] |
| catalog_object_id | str | The CatalogItemVariation id applied to this returned line item. | [optional] |
| variation_name | str | The name of the variation applied to this returned line item. | [optional] |
| return_modifiers | list[OrderReturnLineItemModifier] | The CatalogModifiers applied to this line item. | [optional] |
| return_taxes | 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. | [optional] |
| return_discounts | 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. | [optional] |
| base_price_money | Money | The base price for a single unit of the line item. | [optional] |
| variation_total_price_money | 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] |
| gross_return_money | Money | The gross return amount of money calculated as (item base price + modifiers price) * quantity. This field is read-only. | [optional] |
| total_tax_money | Money | The total tax amount of money to return for the line item. This field is read-only. | [optional] |
| total_discount_money | Money | The total discount amount of money to return for the line item. This field is read-only. | [optional] |
| total_money | Money | The total amount of money to return for this line item. This field is read-only. | [optional] |