Object Index / Definition

You are viewing an old version of the API
Order​Return​Tax

Beta

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.

Properties

Name Description
applied_money
Money

The amount of the money applied by the tax in an order.

catalog_object_id
string

The catalog object id referencing CatalogTax.

Max Length 192
name
string

The tax's name.

Max Length 255
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%.

Max Length 10
scope
string

Indicates the level at which the OrderReturnTax applies. For ORDER scoped taxes, Square generates references in applied_taxes on all OrderReturnLineItems. For LINE_ITEM scoped taxes, the tax will only apply to OrderReturnLineItems with references in their applied_discounts field.

source_tax_uid
string

uid of the Tax from the Order which contains the original charge of this tax.

Max Length 60
type
string

Indicates the calculation method used to apply the tax.

uid
string

Unique ID that identifies the return tax only within this order.

Max Length 60

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?