Item tax data specifications

Use the item_tax_data object to provide tax information for an item. The object can contain one or more of the following tax type keys:

• sales_tax
• bottle_redemption
• bottle_deposit
• sugar_tax
• liquor_tax
• alcohol_tax
• bottle_water_tax
• value_added_tax
• goods_and_services_tax
• provincial_sales_tax
• harmonized_sales_tax
• other

Parameters

The item_tax_data object accepts the following parameters.

Field	Type	Required	Description
tax_type	string	yes	How the tax is calculated. The value must be one of the following: rate_percent or amount_cents.
value	number	yes	The tax value. If tax_type is rate_percent, this is a percentage (for example, 8.5 for 8.5%). If tax_type is amount_cents, this is an amount in cents.
authority	string	no	The taxing authority. The value must be one of the following: national, state, province, region, county, city, parish, or other.

Example

{
  "lookup_code": "1234567890",
  "store_identifier": "1234",
  "item_tax_data": {
    "sales_tax": {
      "tax_type": "rate_percent",
      "value": 8.5,
      "authority": "state"
    },
    "bottle_deposit": {
      "tax_type": "amount_cents",
      "value": 5
    }
  }
}