This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
This section provides reference information about the endpoints and data types of the Toast configuration API. For more information about using the configuration API and code examples, see Getting menu information from the configuration API. For general information about working with Toast APIs, see API overview.
Configuration API
Base URL: /config/v2, Version: 2.2.0
Returns information about the configuration of a restaurant and its menus, such as menu items and alternate payment types, as well as physical configuration such as cash drawers and restaurant tables.
The configuration API does not return information about entities that you have removed from your restaurant configuration or archived.
Summary
Tag: Alternate Payment Types
Operation | Description |
---|---|
GET /alternatePaymentTypes/{guid} | Get an alternative payment type |
GET /alternatePaymentTypes | Get alternative payment types |
Tag: Break Types
Operation | Description |
---|---|
GET /breakTypes/{guid} | Get a break type |
GET /breakTypes | Get break types |
Tag: Payout Reasons
Operation | Description |
---|---|
GET /payoutReasons/{guid} | Get a payout reason |
GET /payoutReasons | Get payout reasons |
Tag: Pre Modifier Groups
Operation | Description |
---|---|
GET /preModifierGroups/{guid} | Get a pre-modifier group |
GET /preModifierGroups | Get pre modifier groups |
Tag: Pre Modifiers
Operation | Description |
---|---|
GET /preModifiers/{guid} | Get a pre modifier |
GET /preModifiers | Get pre-modifiers |
Tag: Price Groups
Operation | Description |
---|---|
GET /priceGroups/{guid} | Get a price level for menu items |
GET /priceGroups | Get price levels for menu items |
Tag: Printers
Operation | Description |
---|---|
GET /printers/{guid} | Get a printer |
GET /printers | Get printers |
Tag: Restaurant Services
Operation | Description |
---|---|
GET /restaurantServices/{guid} | Get a restaurant service period |
GET /restaurantServices | Get restaurant service periods |
Tag: Revenue Centers
Operation | Description |
---|---|
GET /revenueCenters/{guid} | Get a revenue center |
GET /revenueCenters | Get revenue centers |
Tag: Sales Categories
Operation | Description |
---|---|
GET /salesCategories/{guid} | Get a menu item sales category |
GET /salesCategories | Get menu item sales categories |
Tag: Service Areas
Operation | Description |
---|---|
GET /serviceAreas/{guid} | Get a service area |
GET /serviceAreas | Get service areas |
Tag: Service Charges
Operation | Description |
---|---|
GET /serviceCharges/{guid} | Get a service charge type |
GET /serviceCharges | Get service charges |
Tag: Cash Drawers
Operation | Description |
---|---|
GET /cashDrawers/{guid} | Get a cash drawer |
GET /cashDrawers | Get cash drawers |
Tag: Tables
Operation | Description |
---|---|
GET /tables/{guid} | Get a table |
GET /tables | Get tables |
Tag: Tax Rates
Operation | Description |
---|---|
GET /taxRates/{guid} | Get a tax rate |
GET /taxRates | Get tax rates |
Tag: Tip Withholding
Operation | Description |
---|---|
GET /tipWithholding | Get the percentage withheld for credit card tips |
Tag: Void Reasons
Operation | Description |
---|---|
GET /voidReasons/{guid} | Get a void sale reason |
GET /voidReasons | Get void sale reasons |
Tag: Dining Options
Operation | Description |
---|---|
GET /diningOptions/{guid} | Get a dining option |
GET /diningOptions | Get dining options |
Tag: Discounts
Operation | Description |
---|---|
GET /discounts/{guid} | Get a discount |
GET /discounts | Get discounts |
Tag: Menu Groups
Operation | Description |
---|---|
GET /menuGroups/{guid} | Get a menu group |
GET /menuGroups | Get menu groups |
Tag: Menu Items
Operation | Description |
---|---|
GET /menuItems/{guid} | Get a menu item or modifier |
GET /menuItems | Get menu items and modifiers |
Tag: Modifier Groups
Operation | Description |
---|---|
GET /menuOptionGroups/{guid} | Get a modifier group |
GET /menuOptionGroups | Get modifier groups |
Tag: Menus
Operation | Description |
---|---|
GET /menus/{guid} | Get a menu |
GET /menus | Get menus |
Tag: No Sale Reasons
Operation | Description |
---|---|
GET /noSaleReasons/{guid} | Get a no sale reason |
GET /noSaleReasons | Get no sale reasons |
Paths
Returns an array of AlternatePaymentType
objects containing information about alternative forms of payment that are configured for a restaurant. Alternate payment types are forms of payment that are not standard in the Toast POS and that are configured for a particular restaurant. For example, a third-party service that processes payments might be configured as an alternate payment type. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
AlternatePaymentType
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns an AlternatePaymentType
object containing information about an alternative form of payment configured for a restaurant. Alternate payment types are forms of payment that are not standard in the Toast POS and that are configured for a particular restaurant. For example, a third-party service that processes payments might be configured as an alternate payment type.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the alternate payment type is configured for. |
header | string | |
guid | The Toast POS GUID of the alternative form of payment. |
path | string |
application/json
- 200 OK
-
Returns an
AlternatePaymentType
object.
Returns an array of BreakType
objects containing information about breaks configured for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
BreakType
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a BreakType
object containing information about a break type configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the break is configured for. |
header | string | |
guid | The Toast POS GUID of the break config. |
path | string |
application/json
- 200 OK
-
Returns a
BreakType
object.
Returns an array of CashDrawer
objects containing information about the cash drawer devices for the restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
CashDrawer
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a CashDrawer
object containing information about a specific cash drawer device.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the cash drawer. |
path | string |
application/json
- 200 OK
-
Returns a
CashDrawer
object.
Returns an array of DiningOption
objects containing information about types of service offered by a restaurant. For example, dine in, take out, and delivery might be dining options for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
DiningOption
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a DiningOption
object containing information about a type of service offered by a restaurant. For example, dine in, take out, and delivery might be dining options for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the dining option. |
path | string |
application/json
- 200 OK
-
Returns a
DiningOption
object.
Returns an array of Discount
objects containing information about the price deductions configured for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
Discount
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a Discount
object containing information about a price deduction configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the discount. |
path | string |
application/json
- 200 OK
-
Returns a
Discount
object.
Returns an array of NoSaleReason
objects containing information about no sale reasons configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
NoSaleReason
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a NoSaleReason
object containing information about a no sale reason.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the no sale reason. |
path | string |
application/json
- 200 OK
-
Returns a
NoSaleReason
object.
Returns an array of PayoutReason
objects containing information about recurring cash expenses configured for a restaurant. For example, payment for services such as window washing might be payout reasons. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
PayoutReason
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a PayoutReason
object containing information about a recurring restaurant expense that is paid in cash. Payout reasons are pre-configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the payout reason. |
path | string |
application/json
- 200 OK
-
Returns a
PayoutReason
object.
Returns an array of PreModifierGroup
objects containing information about PreModifierGroup configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
PreModifierGroup
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a PreModifierGroup
object containing information about a pre modifier group.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the pre-modifier. |
path | string |
application/json
- 200 OK
-
Returns a
PreModifierGroup
object.
Returns an array of PreModifier
objects containing information about PreModifiers configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
PreModifier
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a PreModifier
object containing information about a pre modifier.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the pre modifier. |
path | string |
application/json
- 200 OK
-
Returns a
PreModifier
object.
Returns an array of PriceGroup
objects containing information about the variable price levels configured for items at a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
PriceGroup
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a PriceGroup
object containing information about a variable price level configured for items at a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the price level. |
path | string |
application/json
- 200 OK
-
Returns a
PriceGroup
object.
Returns an array of Printer
objects containing information about the printer devices configured for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
Printer
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a Printer
object containing information about a printer device configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the printer. |
path | string |
application/json
- 200 OK
-
Returns a
Printer
object.
Returns an array of RestaurantService
objects containing information about the types of menu and dining offered by a restaurant. For example, a restaurant might offer a lunch service at some hours of the day and a dinner service at other hours of the day. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
RestaurantService
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a RestaurantService
object containing information about a type of menu and dining offered by a restaurant. For example, a restaurant might offer a lunch service at some hours of the day and a dinner service at other hours of the day.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the service. |
path | string |
application/json
- 200 OK
-
Returns a
RestaurantService
object.
Returns an array of RevenueCenter
objects containing information about segments of restaurant income, for reporting. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
RevenueCenter
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a RevenueCenter
object containing information about a segment of restaurant income, for reporting.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the revenue center. |
path | string |
application/json
- 200 OK
-
Returns a
RevenueCenter
object.
Returns an array of SalesCategory
objects containing information about the types of menu item used to analyze purchases at a restaurant. For example, food and alcohol might be sales categories for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
SalesCategory
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a SalesCategory
object containing information about a type of menu item used to analyze purchases at a restaurant. For example, food and alcohol might be sales categories for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the sales category. |
path | string |
application/json
- 200 OK
-
Returns a
SalesCategory
object.
Returns an array of ServiceArea
objects containing information about the physical settings that a restaurant serves customers in. For example, a restaurant might serve customers in dining room and patio service areas. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
ServiceArea
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a ServiceArea
object containing information about a physical setting that a restaurant serves customers in. For example, a restaurant might serve customers in dining room and patio service areas.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the service area. |
path | string |
application/json
- 200 OK
-
Returns a
ServiceArea
object.
Returns an array of ServiceCharge
objects containing information about the types of fee applied to restaurant sales. For example, an automatic gratuity applied to the check for a large dining party might be a type of service charge for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
ServiceCharge
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a ServiceCharge
object containing information about a type of fee applied to restaurant sales. For example, an automatic gratuity applied to the check for a large dining party might be a type of service charge for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the service charge. |
path | string |
application/json
- 200 OK
-
Returns a
ServiceCharge
object.
Returns an array of Table
objects containing information about the dining tables configured for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
Table
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a Table
object containing information about a dining table configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the table. |
path | string |
application/json
- 200 OK
-
Returns a
Table
object.
Returns an array of TaxRate
objects containing information about the forms of taxation applied to sales at a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
TaxRate
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a TaxRate
object containing information about a form of taxation applied to sales at a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the tax rate. |
path | string |
application/json
- 200 OK
-
Returns a
TaxRate
object.
Returns a TipWithholding
object containing information about the way tip withholding is configured for a restaurant. Tip withholding is a percentage of employees' credit card tips that is kept by a restaurant to cover credit card processing fees.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string |
application/json
- 200 OK
-
Returns a
TipWithholding
object.
Returns an array of VoidReason
objects containing information about causes for making a sale invalid configured for a restaurant. If a lastModified
date is specified, returns all objects that were created or modified after that date.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
pageToken | A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the |
query | string | |
pageSize | The number of objects to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
page | The sequence number of the first object to return in the array. Deprecated. For more information, see Paginating response data. |
query | integer | |
lastModified | Limits the return data to objects created or modified after a specific date and time. For example: |
query | string (date) |
application/json
- 200 OK
-
Returns an array of
VoidReason
objects.Toast-Next-Page-Token A string that identifies the following set of objects that the endpoint will return. You can use this value to retrieve that page of response data. To return the next page of objects you supply this value in the
pageToken
parameter of the next request to the endpoint. For more information, see Paginating response data.The endpoint does not return the
Toast-Next-Page-Token
field if there is no following page of response data objects. For example, the endpoint will not return aToast-Next-Page-Token
header field if all the data objects fit in one response or if you have reached the last page of response objects.string
Returns a VoidReason
object containing information about a cause for making a sale invalid configured for a restaurant.
Toast-Restaurant-External-ID | The Toast POS GUID of the restaurant that the configuration applies to. |
header | string | |
guid | The Toast POS GUID of the void reason. |
path | string |
application/json
- 200 OK
-
Returns a
VoidReason
object.
Schema definitions
- name: string
-
The name of the alternate payment type.
- name: string
-
The name of the work break type, as recognized by restaurant employees.
- active: boolean
-
Indicates whether the break is available and can be taken by restaurant employees.
- paid: boolean
-
Indicates whether the break is paid.
- duration: integer
-
The duration of the break in minutes.
- enforceMinimumTime: boolean
-
Indicates whether the duration is enforced as the minimum time for the break.
- trackMissedBreaks: boolean
-
True if breaks that are not taken within the specified break interval should be generated in Toast.
- breakIntervalHrs: integer
-
The number of hours between break intervals. Break intervals are specified in hours and minutes. If missed breaks are not tracked, this value may be null.
- breakIntervalMins: integer
-
The number of minutes between break intervals. Break intervals are specified in hours and minutes. If missed breaks are not tracked, this value may be null.
- trackBreakAcknowledgement: boolean
-
Indicates whether break acknowledgements are collected for this type of break. Break acknowledgements will not be collected if
trackMissedBreaks
is false.
- printer: ToastReference
-
The Toast GUID or external identifier of a printer device.
A conditional tax rate that overrides the default rate
for a 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.
- condition: string
-
A string describing the condition for the tax rate
- rate: number (double)
-
The percentage rate of the conditional tax rate
- name: string
-
The name of the dining option.
- behavior: string , x ∈ { DINE_IN , TAKE_OUT , DELIVERY }
-
The behavior of the dining option.
TAKE_OUT
andDELIVERY
require acustomer
to be specified on the order, andDELIVERY
requires adeliveryInfo
value. - curbside: boolean
-
Indicates whether the dining option has curbside behavior, and allows the guest to provide identifying information such as a description of their vehicle.
A discount configured in the Toast administration back-end. Discounts are always applied before taxes, but after service charges are calculated.
- name: string
-
The human-readable name of the discount.
- active: boolean
-
Indicates whether the discount is available and can be applied by restaurant employees.
- type: string , x ∈ { PERCENT , FIXED , OPEN_PERCENT , OPEN_FIXED , BOGO , FIXED_TOTAL }
-
PERCENT
- the discount reduces the price by a preconfigured percent.FIXED
- the discount reduces the price by a preconfigured currency amount.OPEN_PERCENT
- the discount reduces the price by a percent entered by a restaurant employee.OPEN_FIXED
- the discount reduces the price by a currency amount entered by a restaurant employee.BOGO
- a buy one get one (BOGO) discount.FIXED_TOTAL
- a combo discount that reduces the price of all eligible items to a preconfigured currency amount.
- percentage: number (double)
-
Percent discount applied when the
amountType
isPERCENT
. This value will be greater than 0 and at most 100. - amount: number (double)
-
The currency amount of the discount when the
amountType
isFIXED
. This value will be greater than 0. - selectionType: string , x ∈ { CHECK , ITEM , BOGO }
-
CHECK
- the discount can be applied to a check.BOGO
- a buy one get one (BOGO) discount.ITEM
- the discount can be applied to an item selection in a check.
- nonExclusive: boolean
-
Indicates whether you can apply the discount with other discounts. This value is always
false
for item and combo discounts. Set this value for check and BOGO discounts by selecting Allow with other discounts in the Discounts Rules section of the discounts configuration page of the Toast administration back-end. - itemPickingPriority: string , x ∈ { FIRST , LEAST_EXPENSIVE , MOST_EXPENSIVE }
-
Indicates which menu item selections are discounted when you apply a BOGO discount. An item that is discounted by a BOGO discount is a "get" item.
FIRST
- the BOGO discount applies to the first matching item selection in the check or the discount is not a BOGO discount. TheitemPickingPriority
is alwaysFIRST
for discounts that are not BOGO discounts.LEAST_EXPENSIVE
- the BOGO discount applies to the least expensive matching item selection in the check.MOST_EXPENSIVE
- the BOGO discount applies to the most expensive matching item selection in the check.
- fixedTotal: number (double)
-
The total price of items discounted by a combo discount. This value is
null
for discounts that are not combo discounts.
A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.
- externalId: string
-
External identifier string, prefixed by the naming authority.
Information about an image associated with a menu or menu item.
- url: string
-
The web address of the image.
- name: string
-
The name of the menu as it appears in the Toast POS.
- orderableOnline: string , x ∈ { YES , NO }
-
Deprecated. Indicates whether restaurant guests can order from the menu online.
Toast is streamlining and improving the set of configuration options that restaurants use for configuring whether a menu entity can be ordered online. As part of this change, the
orderableOnline
value has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisorderableOnline
value, to determine if the entity should be available for online ordering. See Menu entity visibility enhancements (rolled out) for more information. - visibility: string , x ∈ { ALL , POS_ONLY , NONE }
-
Deprecated. Indicates where the menu is displayed and who can see it.
- ALL: Visible to everyone (servers and customers)
- POS_ONLY: Only visible to servers
- NONE: Hidden from everyone
Toast is streamlining and improving the set of configuration options that restaurants use for configuring where a menu entity is visible (for example, on a Toast POS device or on a restaurant's Toast online ordering website). As part of this change, the
visibility
value in the configuration API has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisvisibility
value, to determine where the entity should be visible. See Menu entity visibility enhancements (rolled out) for more information. - groups: object[]
-
An array of the
MenuGroup
objects that are part of this menu. - images: object[]
-
A collection of images associated with the menu.
- unitOfMeasure: string , x ∈ { NONE , LB , OZ , KG , G }
-
The unit of measure used to determine the price of items in this menu. For example, $10.00 per gram.
- name: string
-
The name of the menu group as it appears in the Toast POS.
- menu: ExternalReference
-
The Toast GUID or external identifier of the menu that this group belongs to.
- orderableOnline: string , x ∈ { YES , NO }
-
Deprecated. Indicates whether restaurant guests can order from the menu online.
Toast is streamlining and improving the set of configuration options that restaurants use for configuring whether a menu entity can be ordered online. As part of this change, the
orderableOnline
value has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisorderableOnline
value, to determine if the entity should be available for online ordering. See Menu entity visibility enhancements (rolled out) for more information. - visibility: string , x ∈ { ALL , POS_ONLY , NONE }
-
Deprecated. Indicates where the menu is displayed and who can see it.
- ALL: Visible to everyone (servers and customers)
- POS_ONLY: Only visible to servers
- NONE: Hidden from everyone
Toast is streamlining and improving the set of configuration options that restaurants use for configuring where a menu entity is visible (for example, on a Toast POS device or on a restaurant's Toast online ordering website). As part of this change, the
visibility
value in the configuration API has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisvisibility
value, to determine where the entity should be visible. See Menu entity visibility enhancements (rolled out) for more information. - parent: ExternalReference
-
The Toast GUID or external identifier of the menu group that is the direct parent of the current menu group. This value is
null
if direct parent of the menu group is a menu. - items: object[]
-
An array of
ExternalReference
objects containing the identifiers of theMenuItem
s in the menu group. - subgroups: object[]
-
An array of
ExternalReference
objects containing the identifiers of the childMenuGroup
s in the menu group. Empty if the menu group does not include any child menu groups. - optionGroups: object[]
-
An array of
ExternalReference
objects containing the identifiers of the childMenuOptionGroup
s that contain modifiers applicable to the group, its subgroups and its items. Does not includeMenuOptionGroup
s inherited from its parentMenuGroup
. - inheritOptionGroups: boolean
-
True if this
MenuGroup
inheritsMenuOptionGroup
s from its parentMenuGroup
. - images: object[]
-
An array of
Image
objects associated with with theMenuGroup
. - unitOfMeasure: string , x ∈ { NONE , LB , OZ , KG , G }
-
The unit of measure used to determine the price of items in this group. This value is not relevant if
inheritUnitOfMeasure
is true. - inheritUnitOfMeasure: boolean
-
True if this
MenuGroup
inherits its unit of measure from its parentMenuGroup
or (if its parent is null) its parentMenu
.
- name: string
-
The name of the menu item as it appears in the Toast POS.
- calories: integer
-
The amount of food energy in the item, expressed in Calorie units. Values can be positive, negative, or zero.
- sku: string
-
The stock keeping unit (SKU) code for the item.
- plu: string
-
The price look up (PLU) code for the item.
- orderableOnline: string , x ∈ { YES , NO }
-
Deprecated. Indicates whether restaurant guests can order from the menu online.
Toast is streamlining and improving the set of configuration options that restaurants use for configuring whether a menu entity can be ordered online. As part of this change, the
orderableOnline
value has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisorderableOnline
value, to determine if the entity should be available for online ordering. See Menu entity visibility enhancements (rolled out) for more information. - visibility: string , x ∈ { ALL , POS_ONLY , NONE }
-
Deprecated. Indicates where the menu is displayed and who can see it.
- ALL: Visible to everyone (servers and customers)
- POS_ONLY: Only visible to servers
- NONE: Hidden from everyone
Toast is streamlining and improving the set of configuration options that restaurants use for configuring where a menu entity is visible (for example, on a Toast POS device or on a restaurant's Toast online ordering website). As part of this change, the
visibility
value in the configuration API has been deprecated. Before 2020-05-25, you should transition to using thevisibility
array that the menus API returns for each menu entity, instead of thisvisibility
value, to determine where the entity should be visible. See Menu entity visibility enhancements (rolled out) for more information. - type: string , x ∈ { NONE , OPEN_ITEM , SPECIAL_REQUEST , PORTION }
-
Specifies whether this item is a special request or other off-menu transaction.
NONE
- a normal menu item or modifier.OPEN_ITEM
- an item that is not on a menu.SPECIAL_REQUEST
- a selection that is not an item.PORTION
- a division of a menu item used to apply modifiers separately to separate parts of an item. For example, one half of a pizza.
- optionGroups: object[]
-
An array of
ExternalReference
objects containing the identifiers of theMenuOptionGroup
s that contain modifiers applicable to this item. Does not include those inherited from the parentMenuGroup
. - inheritOptionGroups: boolean
-
True if this menu item inherits
MenuOptionGroup
s from its parentMenuGroup
. - images: object[]
-
An array of
Image
objects that are associated with theMenuItem
. - unitOfMeasure: string , x ∈ { NONE , LB , OZ , KG , G }
-
The unit of measure used to determine the price of the item. The default is NONE. This value is not relevant if
inheritUnitOfMeasure
is true. - inheritUnitOfMeasure: boolean
-
True if this menu item inherits its unit of measure from its parent
MenuGroup
.
- name: string
-
The name of the
MenuOptionGroup
as it appears in the Toast POS. - options: object[]
-
An array of
ExternalReference
objects containing the identifiers of theMenuItem
s in the menu group. - minSelections: number (integer)
-
The minimum number of selections that must be made from this option group.
- maxSelections: number (integer)
-
The maximum number of selections that can be made from this option group.
- name: string
-
The name of the no sale reason that appears in the Toast POS.
- name: string
-
The short name of this payout reason.
- name: string
-
The name of the pre modifier that appears in the Toast POS.
- scalePrice: boolean
-
True if this multiplies the modifier price, false if it adds to the modifier price.
- basePrice: number (double)
-
Amount to add to the modifier price, if scalePrice is false. Otherwise not used.
- scaleFactor: number (float)
-
Amount to multiply the modifier price, if scalePrice is true. Otherwise not used.
- displayMode: string , x ∈ { PREFIX , SUFFIX }
-
Where this premodifier should be displayed relative to the modifier name. PREFIX - before the modifier name SUFFIX - after the modifier name
- parent: ToastReference
-
The pre modifier group the premodifier belongs to.
- name: string
-
The name of the pre modifier that appears in the Toast POS.
- isDefault: boolean
-
True if this PreModifierGroup is set as the default Group. Only a single PreModifierGroup can be set as default at one time.
- name: string
-
The name of this price group.
- name: string
-
The name of this printer.
- name: string
-
The name of this meal service (for example,
Lunch
orDinner
).
A set of ServiceAreas and POS devices for which separate revenue reports can be generated. For instance, a restaurant with a bar might choose to define two RevenueCenters, one for the bar and one for the dining area.
- name: string
-
The name of this revenue center.
- description: string
-
The description of this revenue center.
A set of items that will be grouped together in sales reports. SalesCategories can be applied at any level, from entire menus to individual menu items.
- name: string
-
The name of this sales category.
A representation of a physical service area, a group of tables, in a restaurant.
- name: string
-
The name of this service area.
- revenueCenter: ExternalReference
-
The revenue center the service area belongs to.
Any charge applied to a check for something other than menu item. Typical examples include gratuity and delivery fees.
- name: string
-
The name of this service charge.
- amountType: string , x ∈ { FIXED , PERCENT , OPEN }
-
The type of service charge.
- amount: number (double)
-
Amount in USD to be applied for
FIXED
type service charges. - percent: number (double)
-
Percent fee to be applied for
PERCENT
type service charges, based on pre-discount check amount. Must be a number between 0 and 100. - criteria: ServiceChargeCriteria
-
A reference to the ServiceChargeCriteria to determine if this service charge is applicable to a given check. See each ServiceChargeCriteria for details.
- gratuity: boolean
-
True if the service charge is a gratuity and is assigned to the owner of the check.
- taxable: boolean
-
True if tax should be applied to the service charge.
- applicableTaxes: object[]
-
A reference to the taxes applied to the service charge, if the service charge is taxable.
- serviceChargeCalculation: string , x ∈ { PRE_DISCOUNT , POST_DISCOUNT }
-
Defines whether or not the service charge is applied before (PRE) or after (POST) discounts. This field is null for non-percent service charges.
Describes thresholds for when a service charge should be applied to a check.
- minCheckAmount: number (double)
-
The service charge is only applicable if the pre-discount check is at least this amount.
- delivery: boolean
-
True if the service charge is only applicable for deliveries.
- maxCheckAmount: number (double)
-
The service charge is waived if the pre-discount check amount is more than this amount. A
null
value means this criteria is inapplicable. - minDeliveryDistance: number (double)
-
The service charge is only applicable to deliveries that are at least this distance. A
null
value means this criteria is inapplicable. - takeout: boolean
-
Indicates whether the service charge is automatically applied to orders that have the takeout dining option behavior.
- dineIn: boolean
-
Indicates whether the service charge is applied to orders that have the dine-in dining option behavior.
Represents a dining table in a restaurant.
- name: string
-
The human-readable name of this table as it appears in the POS.
- serviceArea: ToastReference
-
The service area the table belongs to.
- revenueCenter: ExternalReference
-
The revenue center the table belongs to.
- name: string
-
The name of this tax rate.
- isDefault: boolean
-
True if this tax rate is the default 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
isNONE
, thenrate
isnull
. - type: string , x ∈ { PERCENT , FIXED , TABLE , NONE , EXTERNAL }
-
The type of the tax rate.
- roundingType: string , x ∈ { HALF_UP , HALF_EVEN , ALWAYS_UP , ALWAYS_DOWN }
-
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
isnull
.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.
- taxTable: object[]
-
An array of
TaxTableRow
objects that define a set of tax amounts that apply to specific sale amount ranges. - conditionalTaxRates: object[]
-
An array of
ConditionalTaxRate
objects that indicate the conditional rates that override the defaultrate
for thisTaxRate
in specific situations. For example, a conditional rate might override the default rate when aTaxRate
is applied for a specific dining option, such as takeout.
A closed sale amount range that corresponds to a specific tax amount in a tax table.
- start: number (currency)
-
The start of a sale amount range that corresponds to a specific tax amount in a tax table.
- end: number (currency)
-
The end of a sale amount range that corresponds to a specific tax amount in a tax table.
- tax: number (currency)
-
The tax amount for the tax table row.
- pattern: boolean
-
Specifies whether the price range is part of an incomplete set of ranges that establish an algorithm that you can use to calculate tax amounts.
Information about the way tip withholding is configured for a restaurant. Tip withholding is a percentage of employees' credit card tips and service charges that are paid to employees as a gratuity that is kept by a restaurant to cover credit card processing fees.
- enabled: boolean
-
Indicates whether a restaurant location withholds a percent of employees' credit card tips.
true
- the location keeps a percent of employees' credit card tips.false
- the location does not keep a percent of employees' credit card tips.
- percentage: number
-
The decimal percentage of credit card tips withheld. If tip withholding is not
enabled
, tips will not be withheld in the Toast platform regardless of this value.
A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
- guid: string
-
The GUID maintained by the Toast POS.
- entityType: string
-
The type of object this is.
When voiding something through the POS, the user must choose a preconfigured void reason.
- name: string
-
The name of this void reason.