OrderReturnTax

October 23, 2019 · View on GitHub

Description

Represents a tax being returned that applies to one or more return line items in an order. Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals. The amount distributed to each return line item is relative to that item’s contribution to the order subtotal. Note: This model is in beta.

Properties

NameTypeDescriptionNotes
uidStringUnique ID that identifies the return tax only within this order.[optional]
sourceTaxUidString`uid` of the Tax from the Order which contains the original charge of this tax.[optional]
catalogObjectIdStringThe catalog object id referencing `CatalogTax`.[optional]
nameStringThe tax's name.[optional]
typeStringIndicates the calculation method used to apply the tax. See OrderLineItemTaxType for possible values[optional]
percentageStringThe percentage of the tax, as a string representation of a decimal number. For example, a value of `"7.25"` corresponds to a percentage of 7.25%.[optional]
appliedMoneyMoneyThe amount of the money applied by the tax in an order.[optional]
scopeStringIndicates the level at which the `OrderReturnTax` applies. For `ORDER` scoped taxes, Square generates references in `applied_taxes` on all `OrderReturnLineItem`s. For `LINE_ITEM` scoped taxes, the tax will only apply to `OrderReturnLineItem`s with references in their `applied_discounts` field. See OrderLineItemTaxScope for possible values[optional]