CatalogTax Object - Square API Reference

Name	Description
`name string`	The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. Max Length 255
`calculation_phase string`	Whether the tax is calculated based on a payment's subtotal or total.
`inclusion_type string`	Whether the tax is `ADDITIVE` or `INCLUSIVE`.
`percentage string`	The 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%.
`applies_to_custom_amounts boolean`	If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular `CatalogItem`.
`enabled boolean`	A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`).

The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Max Length 255


          
  
  
            calculation_phase
          


        

        
    string

Whether the tax is calculated based on a payment's subtotal or total.


          
  
  
            inclusion_type
          


        

        
    string

Whether the tax is ADDITIVE or INCLUSIVE.

The 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%.


          
  
  
            applies_to_custom_amounts
          


        

        
    boolean

If true, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular CatalogItem.

A Boolean flag to indicate whether the tax is displayed as enabled (true) in the Square Point of Sale app or not (false).

Object Index

You are viewing an old version of the API

All Versions

CatalogTax