Object Index / Definition

You are viewing an old version of the API
OrderReturnTax

Beta

Represents a tax being returned that applies to one or more return line items in an order.

Properties

Name Description
uid
string

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

Max Length 60
source_tax_uid
string

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

Max Length 60
catalog_object_id
string

The catalog object id referencing CatalogTax.

Max Length 192
name
string

The tax's name.

Max Length 255
type
string

Indicates the calculation method used to apply the tax. See OrderLineItemTaxType for possible values

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
applied_money
Money

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

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. See OrderLineItemTaxScope for possible values

Share Feedback

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