CatalogTax

September 24, 2019 ยท View on GitHub

Description

A tax in the Catalog object model.

Properties

NameTypeDescriptionNotes
nameStringThe tax's name. Searchable. This field has max length of 255 Unicode code points.[optional]
calculationPhaseStringWhether the tax is calculated based on a payment's subtotal or total. See TaxCalculationPhase for possible values[optional]
inclusionTypeStringWhether the tax is `ADDITIVE` or `INCLUSIVE`. See TaxInclusionType for possible values[optional]
percentageStringThe percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%.[optional]
appliesToCustomAmountsBooleanIf `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`.[optional]
enabledBooleanIf `true`, the tax will be shown as enabled in the Square Point of Sale app.[optional]