OrderReturnTax
September 24, 2019 · View on GitHub
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.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| uid | getUid() | setUid($value) | string | Unique ID that identifies the return tax only within this order. | [optional] |
| source_tax_uid | getSourceTaxUid() | setSourceTaxUid($value) | string | `uid` of the Tax from the Order which contains the original charge of this tax. | [optional] |
| catalog_object_id | getCatalogObjectId() | setCatalogObjectId($value) | string | The catalog object id referencing `CatalogTax`. | [optional] |
| name | getName() | setName($value) | string | The tax's name. | [optional] |
| type | getType() | setType($value) | string | Indicates the calculation method used to apply the tax. See OrderLineItemTaxType for possible values | [optional] |
| percentage | getPercentage() | setPercentage($value) | 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] |
| applied_money | getAppliedMoney() | setAppliedMoney($value) | \SquareConnect\Model\Money | The amount of the money applied by the tax in an order. | [optional] |
| scope | getScope() | setScope($value) | 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] |
Note: All properties are protected and only accessed via getters and setters.