Object Index
You are viewing an old version of the API
OrderReturnTax
BETA
Object Index
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 |
---|---|
uid
|
A unique ID that identifies the returned tax only within this order. |
source_
|
The tax |
catalog_
|
The catalog object ID referencing CatalogTax. |
catalog_
|
The version of the catalog object that this tax references. |
name
|
The tax's name. |
type
|
Indicates the calculation method used to apply the tax. |
percentage
|
The percentage of the tax, as a string representation of a decimal number.
For example, a value of |
applied_
|
The amount of money applied by the tax in an order. |
scope
|
Indicates the level at which the |