AppliedTaxRate

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

• displayName:
  string

  The name of the tax rate as it appears on guest receipts.

• entityType required:
  string

  The type of object this is.

• facilitatorCollectAndRemitTax:
  boolean

  Indicates whether the marketplace facilitator that received a guest order remitted the tax amount on behalf of the Toast platform restaurant.

  You can use this information to identify tax amounts that have already been paid by an ordering service provider and do not need to be paid again.

  • true - The marketplace facilitator paid the tax amount on behalf of the Toast platform restaurant location.

  • false - The marketplace facilitator has not paid the tax amount. The Toast platform restaurant location may be required to pay the tax amount.

  Note: Toast API response data is not guidance or advice for tax compliance.

• guid required:
  string

  The GUID maintained by the Toast platform.

• jurisdiction:
  string

  The state or province of the tax rate for reporting purposes.

• jurisdictionType:
  string

  The jurisdiction type (ex. STATE, COUNTY, etc.) of the tax rate for reporting purposes.

• name:
  string

  The name of the tax rate.

• rate:
  number <double>

  The tax rate, which can be a fixed amount, a percentage, or null.

• taxAmount:
  number <double>

  The tax amount that was actually applied.

• taxRate required:
  object (ToastReference)

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

• type:
  string

  The type of the tax rate. Default is PERCENT.

  The value EXTERNAL indicates that the tax is for a marketplace facilitator order, and that the marketplace facilitator organization calculated the tax amount.

  Enum: "PERCENT" "FIXED" "NONE" "TABLE" "EXTERNAL"

{
  "guid": "string",
  "entityType": "string",
  "taxRate": {
    "guid": "string",
    "entityType": "string"
  },
  "name": "string",
  "rate": 0,
  "taxAmount": 0,
  "type": "PERCENT",
  "facilitatorCollectAndRemitTax": true,
  "displayName": "string",
  "jurisdiction": "string",
  "jurisdictionType": "string"
}