<- Object

Object

OrderReturnTaxBeta

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.

Link to section

Properties

Link to section

uid

string

A unique ID that identifies the returned tax only within this order.

Max Length
60
Link to section

source_tax_uid

string

The tax uid from the order that contains the original tax charge.

Max Length
60
Link to section

catalog_object_id

string

Max Length
192
Link to section

catalog_version

integer(64-bit)

The version of the catalog object that this tax references.

Link to section

name

string

The tax's name.

Max Length
255
Link to section

type

string

Indicates the calculation method used to apply the tax.

Link to section

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
Link to section

applied_money

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

Link to section

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 is only applied to OrderReturnLineItems with references in their applied_discounts field.