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

Files

Latest commit

c63cb87 · Oct 23, 2019

History

History
22 lines (15 loc) · 1.82 KB

OrderReturnTax.md

File metadata and controls

22 lines (15 loc) · 1.82 KB

OrderReturnTax

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

Name Type Description Notes
uid String Unique ID that identifies the return tax only within this order. [optional]
sourceTaxUid String `uid` of the Tax from the Order which contains the original charge of this tax. [optional]
catalogObjectId String The catalog object id referencing `CatalogTax`. [optional]
name String The tax's name. [optional]
type String Indicates the calculation method used to apply the tax. See OrderLineItemTaxType for possible values [optional]
percentage String The 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]
appliedMoney Money The amount of the money applied by the tax in an order. [optional]
scope String Indicates 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]