Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 2.95 KB

OrderLineItemTax.md

File metadata and controls

17 lines (14 loc) · 2.95 KB

OrderLineItemTax

Properties

Name Type Description Notes
Uid string Unique ID that identifies the tax only within this order. [optional] [default to null]
CatalogObjectId string The catalog object id referencing `CatalogTax`. [optional] [default to null]
Name string The tax's name. [optional] [default to null]
Type_ string Indicates the calculation method used to apply the tax. See OrderLineItemTaxType for possible values [optional] [default to null]
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%. [optional] [default to null]
Metadata map[string]string 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 (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set `[a-zA-Z0-9_-]`. Entries may also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ':' character. Values have a max length of 255 characters. An application may 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. See Metadata for more information. [optional] [default to null]
AppliedMoney *Money [optional] [default to null]
Scope string Indicates the level at which the tax applies. For `ORDER` scoped taxes, Square generates references in `applied_taxes` on all order line items that do not have them. For `LINE_ITEM` scoped taxes, the tax will only apply to line items with references in their `applied_taxes` field. This field is immutable. To change the scope, you must delete the tax and re-add it as a new tax. See OrderLineItemTaxScope for possible values [optional] [default to null]
AutoApplied bool 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. [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]