Get a tax rate

Returns a TaxRate object containing information about a form of taxation applied to sales at a restaurant.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The Toast POS GUID of the tax rate.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The Toast POS GUID of the restaurant that the configuration applies to.

Responses

200

Returns a TaxRate object.

get /taxRates/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/config/v2/taxRates/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "entityType": "string",
  "name": "string",
  "isDefault": true,
  "rate": 0,
  "type": "PERCENT",
  "roundingType": "HALF_UP",
  "taxTable": [
    {
      "start": 0,
      "end": 0,
      "tax": 0,
      "pattern": true
    }
  ],
  "conditionalTaxRates": [
    {
      "condition": "string",
      "rate": 0
    }
  ]
}