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

Latest commit

 

History

History
29 lines (24 loc) · 3.07 KB

OrderReturnLineItem.md

File metadata and controls

29 lines (24 loc) · 3.07 KB
Raw

SquareConnect.OrderReturnLineItem

Description

Note: This model is in beta.

The line item being returned in an Order.

Properties

Name Type Description Notes
uid String Unique identifier for this return line item entry. [optional]
source_line_item_uid 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"`.
quantity_unit 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]
catalog_object_id String The `CatalogItemVariation` id applied to this returned line item. [optional]
variation_name String The name of the variation applied to this returned line item. [optional]
return_modifiers [OrderReturnLineItemModifier] The `CatalogModifier`s applied to this line item. [optional]
applied_taxes [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]
applied_discounts [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]
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. [optional]
total_tax_money Money The total tax amount of money to return for the line item. [optional]
total_discount_money Money The total discount amount of money to return for the line item. [optional]
total_money Money The total amount of money to return for this line item. [optional]