OrderReturn
October 23, 2019 ยท View on GitHub
Description
The set of line items, service charges, taxes, discounts, tips, etc. being returned in an Order. Note: This model is in beta.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| uid | String | Unique ID that identifies the return only within this order. | [optional] |
| sourceOrderId | String | Order which contains the original sale of these returned line items. This will be unset for unlinked returns. | [optional] |
| returnLineItems | List<OrderReturnLineItem> | Collection of line items which are being returned. | [optional] |
| returnServiceCharges | List<OrderReturnServiceCharge> | Collection of service charges which are being returned. | [optional] |
| returnTaxes | List<OrderReturnTax> | Collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order. | [optional] |
| returnDiscounts | List<OrderReturnDiscount> | Collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order. | [optional] |
| roundingAdjustment | OrderRoundingAdjustment | A positive or negative rounding adjustment to the total value being returned. Commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. | [optional] |
| returnAmounts | OrderMoneyAmounts | Aggregate monetary value being returned by this Return entry. | [optional] |