Skip to content

order-line-item-tax.md

Latest commit

 

History

History
40 lines (30 loc) · 3.45 KB

order-line-item-tax.md

File metadata and controls

40 lines (30 loc) · 3.45 KB
Raw

Order Line Item Tax

Represents a tax that applies to one or more line item in the order.

Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals. The amount distributed to each line item is relative to the amount the item contributes to the order subtotal.

Structure

Order Line Item Tax

Fields

Name Type Tags Description
uid str Optional A unique ID that identifies the tax only within this order.
Constraints: Maximum Length: 60
catalog_object_id str Optional The catalog object ID referencing CatalogTax.
Constraints: Maximum Length: 192
catalog_version long|int Optional The version of the catalog object that this tax references.
name str Optional The tax's name.
Constraints: Maximum Length: 255
type str (Order Line Item Tax Type) Optional Indicates how the tax is applied to the associated line item or order.
percentage str Optional 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%.
Constraints: Maximum Length: 10
metadata Dict[str, str] Optional Application-defined data attached to this tax. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set
[a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same
application.

For more information, see Metadata.
applied_money Money Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
scope str (Order Line Item Tax Scope) Optional Indicates whether this is a line-item or order-level tax.
auto_applied bool Optional Determines whether the tax was automatically applied to the order based on
the catalog configuration. For an example, see
Automatically Apply Taxes to an Order.

Example (as JSON)

{
  "uid": "uid4",
  "catalog_object_id": "catalog_object_id2",
  "catalog_version": 190,
  "name": "name4",
  "type": "ADDITIVE"
}