TaxRate

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

Array of objects (ConditionalTaxRate)

An array of ConditionalTaxRate objects that indicate the conditional rates that override the default rate for this TaxRate in specific situations. For example, a conditional rate might override the default rate when a TaxRate is applied for a specific dining option, such as takeout.

entityType
required
string

The type of object this is.

guid
required
string

The GUID maintained by the Toast POS.

isDefault
boolean

True if this tax rate is the default tax rate.

name
string

The name of this tax rate.

rate
number <double>

The tax rate value.

For a fixed amount tax rate, is the fixed amount of the tax.

For a percent tax rate, the percentage is expressed as a decimal value. For example, if the tax rate is 6.25%, then rate is 0.0625.

If type is NONE, then rate is null.

roundingType
string

The method used to round fractional currency amounts to non-fractional currency amounts.

Only applies to PERCENT tax rates. For other tax rate types, roundingType is null.

Valid values:

  • HALF_UP - Round values up or down to the nearest number. If the last digit is 5, which is halfway, then always round up to the nearest number.

  • HALF_EVEN - Round values up or down to the nearest number. If the last digit is 5, which is halfway, then round up or down to the nearest even number.

  • ALWAYS_UP - Always round up to the next number.

  • ALWAYS_DOWN - Always round down to the next number.

For more details and examples, see Rounding options.

Enum: "HALF_UP" "HALF_EVEN" "ALWAYS_UP" "ALWAYS_DOWN"
Array of objects (TaxTableRow)

An array of TaxTableRow objects that define a set of tax amounts that apply to specific sale amount ranges.

type
string

The type of the tax rate.

Enum: "PERCENT" "FIXED" "TABLE" "NONE" "EXTERNAL"
{
  • "guid": "string",
  • "entityType": "string",
  • "name": "string",
  • "isDefault": true,
  • "rate": 0,
  • "type": "PERCENT",
  • "roundingType": "HALF_UP",
  • "taxTable": [
    ],
  • "conditionalTaxRates": [
    ]
}