{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/configuration/operation/payoutReasonsGet/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/configuration/operation/payoutReasonsGet/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"2.5.0\",\"title\":\"Configuration API\",\"description\":\"Returns information about the configuration of a restaurant and \\nits menus, such as menu items and alternate payment types, as \\nwell as physical configuration such as cash drawers and \\nrestaurant tables.\\n\\nThe configuration API does not return information about entities that you have \\nremoved from your restaurant configuration or archived.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Alternate Payment Types\"},{\"name\":\"Break Types\"},{\"name\":\"Cash Drawers\"},{\"name\":\"Dining Options\"},{\"name\":\"Discounts\"},{\"name\":\"Menu Groups\"},{\"name\":\"Menu Items\"},{\"name\":\"Modifier Groups\"},{\"name\":\"Menus\"},{\"name\":\"No Sale Reasons\"},{\"name\":\"Payout Reasons\"},{\"name\":\"Pre Modifier Groups\"},{\"name\":\"Pre Modifiers\"},{\"name\":\"Price Groups\"},{\"name\":\"Printers\"},{\"name\":\"Restaurant Services\"},{\"name\":\"Revenue Centers\"},{\"name\":\"Sales Categories\"},{\"name\":\"Service Areas\"},{\"name\":\"Service Charges\"},{\"name\":\"Tables\"},{\"name\":\"Tax Rates\"},{\"name\":\"Tip Withholding\"},{\"name\":\"Void Reasons\"}],\"paths\":{\"/alternatePaymentTypes/{guid}\":{\"get\":{\"tags\":[\"Alternate Payment Types\"],\"operationId\":\"alternatePaymentTypesGuidGet\",\"summary\":\"Get an alternative payment type\\n\",\"description\":\"Returns an `AlternatePaymentType`\\nobject containing information about an alternative form of payment\\nconfigured for a restaurant. Alternate payment types are forms\\nof payment that are not standard in the Toast POS and that are\\nconfigured for a particular restaurant. For example, a\\nthird-party service that processes payments might be configured\\nas an alternate payment type.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the alternate payment\\ntype is configured for.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the alternative form of payment.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns an `AlternatePaymentType` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AlternatePaymentType\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/alternatePaymentTypes\":{\"get\":{\"tags\":[\"Alternate Payment Types\"],\"operationId\":\"alternatePaymentTypesGet\",\"summary\":\"Get alternative payment types\\n\",\"description\":\"Returns an array of `AlternatePaymentType`\\nobjects containing information about alternative forms of\\npayment that are configured for a restaurant. Alternate\\npayment types are forms of payment that are not standard in the\\nToast POS and that are configured for a particular restaurant.\\nFor example, a third-party service that processes payments\\nmight be configured as an alternate payment type. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `AlternatePaymentType` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/AlternatePaymentType\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/breakTypes/{guid}\":{\"get\":{\"tags\":[\"Break Types\"],\"operationId\":\"breakTypesGuidGet\",\"summary\":\"Get a break type\\n\",\"description\":\"Returns a `BreakType`\\nobject containing information about a break type configured for \\na restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the break is configured for.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the break config.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `BreakType` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BreakType\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/breakTypes\":{\"get\":{\"tags\":[\"Break Types\"],\"operationId\":\"breakTypesGet\",\"summary\":\"Get break types\\n\",\"description\":\"Returns an array of `BreakType`\\nobjects containing information about breaks configured for a\\nrestaurant. If a `lastModified` date is specified, returns\\nall objects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `BreakType` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/BreakType\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/cashDrawers/{guid}\":{\"get\":{\"tags\":[\"Cash Drawers\"],\"operationId\":\"cashDrawersGuidGet\",\"summary\":\"Get a cash drawer\\n\",\"description\":\"Returns a `CashDrawer`\\nobject containing information about a specific cash drawer\\ndevice.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the cash drawer.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `CashDrawer` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CashDrawer\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/cashDrawers\":{\"get\":{\"tags\":[\"Cash Drawers\"],\"operationId\":\"cashDrawersGet\",\"summary\":\"Get cash drawers\\n\",\"description\":\"Returns an array of `CashDrawer` objects\\ncontaining information about the cash drawer devices for the\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `CashDrawer` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/CashDrawer\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/diningOptions/{guid}\":{\"get\":{\"tags\":[\"Dining Options\"],\"operationId\":\"diningOptionsGuidGet\",\"summary\":\"Get a dining option\\n\",\"description\":\"Returns a `DiningOption` object\\ncontaining information about a type of service offered by a\\nrestaurant. For example, dine in, take out, and delivery might\\nbe dining options for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the dining option.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `DiningOption` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DiningOption\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/diningOptions\":{\"get\":{\"tags\":[\"Dining Options\"],\"operationId\":\"diningOptionsGet\",\"summary\":\"Get dining options\\n\",\"description\":\"Returns an array of `DiningOption` objects\\ncontaining information about types of service offered by a\\nrestaurant. For example, dine in, take out, and delivery might\\nbe dining options for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `DiningOption` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/DiningOption\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/discounts/{guid}\":{\"get\":{\"tags\":[\"Discounts\"],\"operationId\":\"discountsGuidGet\",\"summary\":\"Get a discount\\n\",\"description\":\"Returns a `Discount`\\nobject containing information about a price deduction\\nconfigured for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the discount.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Discount` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Discount\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/discounts\":{\"get\":{\"tags\":[\"Discounts\"],\"operationId\":\"discountsGet\",\"summary\":\"Get discounts\\n\",\"description\":\"Returns an array of `Discount` objects containing\\ninformation about the price deductions configured for a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Discount` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Discount\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuGroups/{guid}\":{\"get\":{\"tags\":[\"Menu Groups\"],\"operationId\":\"menuGroupsGuidGet\",\"summary\":\"Get a menu group\\n\",\"description\":\"Returns a `MenuGroup`\\nobject containing information about a section within a menu.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the menu group.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuGroups\":{\"get\":{\"tags\":[\"Menu Groups\"],\"operationId\":\"menuGroupsGet\",\"summary\":\"Get menu groups\\n\",\"description\":\"Returns an array of `MenuGroup` objects\\ncontaining information about the subsections of the menus\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuItems/{guid}\":{\"get\":{\"tags\":[\"Menu Items\"],\"operationId\":\"menuItemsGuidGet\",\"summary\":\"Get a menu item or modifier\\n\",\"description\":\"Returns a `MenuItem`\\nobject containing information about an item or modifier available from a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID for the menu item.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuItem` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuItems\":{\"get\":{\"tags\":[\"Menu Items\"],\"operationId\":\"menuItemsGet\",\"summary\":\"Get menu items and modifiers\\n\",\"description\":\"Returns an array of `MenuItem` objects containing\\ninformation about the items and modifiers available from a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuItem` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuItem\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuOptionGroups/{guid}\":{\"get\":{\"tags\":[\"Modifier Groups\"],\"operationId\":\"menuOptionGroupsGuidGet\",\"summary\":\"Get a modifier group\\n\",\"description\":\"Returns a `MenuOptionGroup`\\nobject containing information about a modifier group. For\\nexample, salad dressings might be a modifier group for a\\nsalad menu item.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the modifier group.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `MenuOptionGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MenuOptionGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menuOptionGroups\":{\"get\":{\"tags\":[\"Modifier Groups\"],\"operationId\":\"menuOptionGroupsGet\",\"summary\":\"Get modifier groups\\n\",\"description\":\"Returns an array of `MenuOptionGroup`\\nobjects containing information about modifier groups. \\nFor example, salad dressings might be a modifier group\\nfor a salad menu item. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `MenuOptionGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/MenuOptionGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menus/{guid}\":{\"get\":{\"tags\":[\"Menus\"],\"operationId\":\"menusGuidGet\",\"summary\":\"Get a menu\\n\",\"description\":\"Returns a `Menu` object\\ncontaining information about a menu configured for a\\nrestaurant. For example, a restaurant might have drinks,\\ndinner, and dessert menus.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the menu.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Menu` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Menu\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/menus\":{\"get\":{\"tags\":[\"Menus\"],\"operationId\":\"menusGet\",\"summary\":\"Get menus\\n\",\"description\":\"Returns an array of `Menu`\\nobjects containing information about menus configured for a\\nrestaurant. For example, a restaurant might have drinks,\\ndinner, and dessert menus. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Menu` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Menu\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifiers/{guid}\":{\"get\":{\"tags\":[\"Pre Modifiers\"],\"operationId\":\"preModifiersGuidGet\",\"summary\":\"Get a pre modifier\\n\",\"description\":\"Returns a `PreModifier` object\\ncontaining information about a pre modifier.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the pre modifier.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PreModifier` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifiers\":{\"get\":{\"tags\":[\"Pre Modifiers\"],\"operationId\":\"preModifiersGet\",\"summary\":\"Get pre-modifiers\\n\",\"description\":\"Returns an array of `PreModifier` objects\\ncontaining information about PreModifiers configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PreModifier` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PreModifier\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifierGroups/{guid}\":{\"get\":{\"tags\":[\"Pre Modifier Groups\"],\"operationId\":\"preModifierGroupsGuidGet\",\"summary\":\"Get a pre-modifier group\\n\",\"description\":\"Returns a `PreModifierGroup` object\\ncontaining information about a pre modifier group.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the pre-modifier.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PreModifierGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/preModifierGroups\":{\"get\":{\"tags\":[\"Pre Modifier Groups\"],\"operationId\":\"preModifierGroupsGet\",\"summary\":\"Get pre modifier groups\\n\",\"description\":\"Returns an array of `PreModifierGroup` objects\\ncontaining information about PreModifierGroup configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PreModifierGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PreModifierGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/noSaleReasons/{guid}\":{\"get\":{\"tags\":[\"No Sale Reasons\"],\"operationId\":\"noSaleReasonsGuidGet\",\"summary\":\"Get a no sale reason\\n\",\"description\":\"Returns a `NoSaleReason` object\\ncontaining information about a no sale reason.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the no sale reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `NoSaleReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NoSaleReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/noSaleReasons\":{\"get\":{\"tags\":[\"No Sale Reasons\"],\"operationId\":\"noSaleReasonsGet\",\"summary\":\"Get no sale reasons\\n\",\"description\":\"Returns an array of `NoSaleReason` objects\\ncontaining information about no sale reasons configured\\nfor a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `NoSaleReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/NoSaleReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/payoutReasons/{guid}\":{\"get\":{\"tags\":[\"Payout Reasons\"],\"operationId\":\"payoutReasonsGuidGet\",\"summary\":\"Get a payout reason\\n\",\"description\":\"Returns a `PayoutReason` object\\ncontaining information about a recurring restaurant expense\\nthat is paid in cash. Payout reasons are pre-configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the payout reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PayoutReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PayoutReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/payoutReasons\":{\"get\":{\"tags\":[\"Payout Reasons\"],\"operationId\":\"payoutReasonsGet\",\"summary\":\"Get payout reasons\\n\",\"description\":\"Returns an array of `PayoutReason` objects\\ncontaining information about recurring cash expenses configured\\nfor a restaurant. For example, payment for services such as\\nwindow washing might be payout reasons. If a `lastModified`\\ndate is specified, returns all objects that were created or\\nmodified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PayoutReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PayoutReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/priceGroups/{guid}\":{\"get\":{\"tags\":[\"Price Groups\"],\"operationId\":\"priceGroupsGuidGet\",\"summary\":\"Get a price level for menu items\\n\",\"description\":\"Returns a `PriceGroup` object\\ncontaining information about a variable price level configured for\\nitems at a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the price level.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PriceGroup` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PriceGroup\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/priceGroups\":{\"get\":{\"tags\":[\"Price Groups\"],\"operationId\":\"priceGroupsGet\",\"summary\":\"Get price levels for menu items\\n\",\"description\":\"Returns an array of `PriceGroup` objects\\ncontaining information about the variable price levels\\nconfigured for items at a restaurant. If a `lastModified` date\\nis specified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PriceGroup` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/PriceGroup\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/printers/{guid}\":{\"get\":{\"tags\":[\"Printers\"],\"operationId\":\"printersGuidGet\",\"summary\":\"Get a printer\\n\",\"description\":\"Returns a `Printer` object\\ncontaining information about a printer device configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the printer.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Printer` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Printer\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/printers\":{\"get\":{\"tags\":[\"Printers\"],\"operationId\":\"printersGet\",\"summary\":\"Get printers\\n\",\"description\":\"Returns an array of `Printer` objects containing\\ninformation about the printer devices configured for a\\nrestaurant. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Printer` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Printer\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/salesCategories/{guid}\":{\"get\":{\"tags\":[\"Sales Categories\"],\"operationId\":\"salesCategoriesGuidGet\",\"summary\":\"Get a menu item sales category\\n\",\"description\":\"Returns a `SalesCategory` object\\ncontaining information about a type of menu item used to\\nanalyze purchases at a restaurant. For example, food and\\nalcohol might be sales categories for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the sales category.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `SalesCategory` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SalesCategory\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/salesCategories\":{\"get\":{\"tags\":[\"Sales Categories\"],\"operationId\":\"salesCategoriesGet\",\"summary\":\"Get menu item sales categories\\n\",\"description\":\"Returns an array of `SalesCategory` objects\\ncontaining information about the types of menu item used to\\nanalyze purchases at a restaurant. For example, food and\\nalcohol might be sales categories for a restaurant. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `SalesCategory` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/SalesCategory\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceAreas/{guid}\":{\"get\":{\"tags\":[\"Service Areas\"],\"operationId\":\"serviceAreasGuidGet\",\"summary\":\"Get a service area\\n\",\"description\":\"Returns a `ServiceArea`\\nobject containing information about a physical setting that a\\nrestaurant serves customers in. For example, a restaurant might\\nserve customers in dining room and patio service areas.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service area.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `ServiceArea` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ServiceArea\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceAreas\":{\"get\":{\"tags\":[\"Service Areas\"],\"operationId\":\"serviceAreasGet\",\"summary\":\"Get service areas\\n\",\"description\":\"Returns an array of `ServiceArea` objects\\ncontaining information about the physical settings that a\\nrestaurant serves customers in. For example, a restaurant might\\nserve customers in dining room and patio service areas. If a\\n`lastModified` date is specified, returns all objects that were\\ncreated or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `ServiceArea` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/ServiceArea\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceCharges/{guid}\":{\"get\":{\"tags\":[\"Service Charges\"],\"operationId\":\"serviceChargesGuidGet\",\"summary\":\"Get a service charge type\\n\",\"description\":\"Returns a `ServiceCharge` object\\ncontaining information about a type of fee applied to\\nrestaurant sales. For example, an automatic gratuity applied to\\nthe check for a large dining party might be a type of service\\ncharge for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service charge.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `ServiceCharge` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ServiceCharge\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/serviceCharges\":{\"get\":{\"tags\":[\"Service Charges\"],\"operationId\":\"serviceChargesGet\",\"summary\":\"Get service charges\\n\",\"description\":\"Returns an array of `ServiceCharge` objects\\ncontaining information about the types of fee applied to\\nrestaurant sales. For example, an automatic gratuity applied to\\nthe check for a large dining party might be a type of service\\ncharge for a restaurant. If a `lastModified` date is specified,\\nreturns all objects that were created or modified after that\\ndate.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `ServiceCharge` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/ServiceCharge\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/revenueCenters/{guid}\":{\"get\":{\"tags\":[\"Revenue Centers\"],\"operationId\":\"revenueCentersGuidGet\",\"summary\":\"Get a revenue center\\n\",\"description\":\"Returns a `RevenueCenter` object\\ncontaining information about a segment of restaurant income,\\nfor reporting.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the revenue center.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `RevenueCenter` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RevenueCenter\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/revenueCenters\":{\"get\":{\"tags\":[\"Revenue Centers\"],\"operationId\":\"revenueCentersGet\",\"summary\":\"Get revenue centers\\n\",\"description\":\"Returns an array of `RevenueCenter` objects\\ncontaining information about segments of restaurant income, for\\nreporting. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `RevenueCenter` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/RevenueCenter\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/restaurantServices/{guid}\":{\"get\":{\"tags\":[\"Restaurant Services\"],\"operationId\":\"restaurantServicesGuidGet\",\"summary\":\"Get a restaurant service period\\n\",\"description\":\"Returns a `RestaurantService`\\nobject containing information about a type of menu and dining\\noffered by a restaurant. For example, a restaurant might offer\\na lunch service at some hours of the day and a dinner service\\nat other hours of the day.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the service.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `RestaurantService` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RestaurantService\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/restaurantServices\":{\"get\":{\"tags\":[\"Restaurant Services\"],\"operationId\":\"restaurantServicesGet\",\"summary\":\"Get restaurant service periods\\n\",\"description\":\"Returns an array of `RestaurantService`\\nobjects containing information about the types of menu and dining\\noffered by a restaurant. For example, a restaurant might offer\\na lunch service at some hours of the day and a dinner service\\nat other hours of the day. If a `lastModified` date is specified, returns all\\nobjects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `RestaurantService` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/RestaurantService\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tables/{guid}\":{\"get\":{\"tags\":[\"Tables\"],\"operationId\":\"tablesGuidGet\",\"summary\":\"Get a table\\n\",\"description\":\"Returns a `Table`\\nobject containing information about a dining table configured for a\\nrestaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the table.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `Table` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Table\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tables\":{\"get\":{\"tags\":[\"Tables\"],\"operationId\":\"tablesGet\",\"summary\":\"Get tables\\n\",\"description\":\"Returns an array of `Table`\\nobjects containing information about the dining tables\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Table` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/Table\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/taxRates/{guid}\":{\"get\":{\"tags\":[\"Tax Rates\"],\"operationId\":\"taxRatesGuidGet\",\"summary\":\"Get a tax rate\\n\",\"description\":\"Returns a `TaxRate` object\\ncontaining information about a form of taxation applied to\\nsales at a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the tax rate.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `TaxRate` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TaxRate\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/taxRates\":{\"get\":{\"tags\":[\"Tax Rates\"],\"operationId\":\"taxRatesGet\",\"summary\":\"Get tax rates\\n\",\"description\":\"Returns an array of `TaxRate` objects\\ncontaining information about the forms of taxation applied to\\nsales at a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `TaxRate` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/TaxRate\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/tipWithholding\":{\"get\":{\"tags\":[\"Tip Withholding\"],\"operationId\":\"tipWithholdingGet\",\"summary\":\"Get the percentage withheld for credit card tips\\n\",\"description\":\"Returns a `TipWithholding`\\nobject containing information about the way tip withholding\\nis configured for a restaurant. Tip withholding is a percentage\\nof employees' credit card tips that is kept by a restaurant to\\ncover credit card processing fees.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration applies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `TipWithholding` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TipWithholding\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/voidReasons/{guid}\":{\"get\":{\"tags\":[\"Void Reasons\"],\"operationId\":\"voidReasonsGuidGet\",\"summary\":\"Get a void sale reason\\n\",\"description\":\"Returns a `VoidReason` object\\ncontaining information about a cause for making a sale invalid\\nconfigured for a restaurant.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"guid\",\"description\":\"The Toast POS GUID of the void reason.\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `VoidReason` object.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/VoidReason\"}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}},\"/voidReasons\":{\"get\":{\"tags\":[\"Void Reasons\"],\"operationId\":\"voidReasonsGet\",\"summary\":\"Get void sale reasons\\n\",\"description\":\"Returns an array of `VoidReason` objects\\ncontaining information about causes for making a sale invalid\\nconfigured for a restaurant. If a `lastModified` date is\\nspecified, returns all objects that were created or modified\\nafter that date.\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast POS GUID of the restaurant that the configuration\\napplies to.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to retrieve one page of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"description\":\"Limits the return data to objects created or modified after\\na specific date and time. For example:\\n`2024-06-20T00:00:00.000%2B0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `VoidReason` objects.\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto retrieve that page of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"maxItems\":300,\"items\":{\"$ref\":\"#/components/schemas/VoidReason\"}}}}}},\"security\":[{\"oauth2\":[\"config:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/config/v2\"}],\"components\":{\"securitySchemes\":{\"oauth2\":{\"description\":\"Access to Toast APIs, specific endpoints, \\nand specific API endpoint operations is \\ncontrolled by the scopes that are associated \\nwith your API account. \\nA full reference for Toast API scopes and \\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"config:read\":\"Allows reading from the configuration API.\\n\"}}}}},\"schemas\":{\"AlternatePaymentType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the alternate payment type.\"}}}]},\"BreakType\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the work break type, as recognized by\\nrestaurant employees.\\n\"},\"active\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break is available and can be taken\\nby restaurant employees.\\n\"},\"paid\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break is paid.\"},\"duration\":{\"type\":\"integer\",\"description\":\"The duration of the break in minutes.\"},\"enforceMinimumTime\":{\"type\":\"boolean\",\"description\":\"Indicates whether the duration is enforced as the minimum\\ntime for the break.\\n\"},\"trackMissedBreaks\":{\"type\":\"boolean\",\"description\":\"True if breaks that are not taken within the specified break\\ninterval should be generated in Toast.\\n\"},\"breakIntervalHrs\":{\"type\":\"integer\",\"description\":\"The number of hours between break intervals. Break intervals\\nare specified in hours and minutes. If missed breaks are not\\ntracked, this value may be null.\\n\"},\"breakIntervalMins\":{\"type\":\"integer\",\"description\":\"The number of minutes between break intervals. Break intervals\\nare specified in hours and minutes. If missed breaks are not\\ntracked, this value may be null.\\n\"},\"trackBreakAcknowledgement\":{\"type\":\"boolean\",\"description\":\"Indicates whether break acknowledgements are collected for\\nthis type of break. Break acknowledgements will not be\\ncollected if `trackMissedBreaks` is false.\\n\"}}}]},\"CashDrawer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"printer\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"DiningOption\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the dining option.\"},\"behavior\":{\"type\":\"string\",\"description\":\"The behavior of the dining option. `TAKE_OUT` and\\n`DELIVERY` require a `customer` to be specified on the\\norder, and `DELIVERY` requires a `deliveryInfo` value.\\n\",\"enum\":[\"DINE_IN\",\"TAKE_OUT\",\"DELIVERY\"]},\"curbside\":{\"type\":\"boolean\",\"description\":\"Indicates whether the dining option has curbside behavior, and allows the guest to\\nprovide identifying information such as a description of their vehicle.\\n\"}}}]},\"Discount\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A discount configured in Toast Web.\\nDiscounts are always applied before taxes, but after\\nservice charges are calculated.\\n\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of the discount.\"},\"active\":{\"type\":\"boolean\",\"description\":\"Indicates whether the discount is available and can be\\napplied by restaurant employees.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"* `PERCENT` - the discount reduces the price by a\\npreconfigured percent.\\n* `FIXED` - the discount reduces the price by a\\npreconfigured currency amount.\\n* `OPEN_PERCENT` - the discount reduces the price by a\\npercent entered by a restaurant employee.\\n* `OPEN_FIXED` - the discount reduces the price by a\\ncurrency amount entered by a restaurant employee.\\n* `BOGO` - a buy one get one (BOGO) discount.\\n* `FIXED_TOTAL` - a combo discount that reduces the\\nprice of all eligible items to a preconfigured currency\\namount.\\n\",\"enum\":[\"PERCENT\",\"FIXED\",\"OPEN_PERCENT\",\"OPEN_FIXED\",\"BOGO\",\"FIXED_TOTAL\"]},\"percentage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Percent discount applied when the `amountType` is\\n`PERCENT`. This value will be greater than 0 and at\\nmost 100.\\n\"},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the discount when the\\n`amountType` is `FIXED`. This value will be greater\\nthan 0.\\n\"},\"selectionType\":{\"type\":\"string\",\"description\":\"* `CHECK` - the discount can be applied to a check.\\n* `BOGO` - a buy one get one (BOGO) discount.\\n* `ITEM` - the discount can be applied to an item\\nselection in a check.\\n\",\"enum\":[\"CHECK\",\"ITEM\",\"BOGO\"]},\"nonExclusive\":{\"type\":\"boolean\",\"description\":\"Indicates whether you can apply the discount with other\\ndiscounts. This value is always `false` for item and\\ncombo discounts. Set this value for check and BOGO\\ndiscounts by selecting **Allow with other discounts** in\\nthe **Discounts Rules** section of the discounts\\nconfiguration page of Toast Web.\\n\"},\"itemPickingPriority\":{\"type\":\"string\",\"description\":\"Indicates which menu item selections are discounted\\nwhen you apply a BOGO discount. An item that is\\ndiscounted by a BOGO discount is a \\\"get\\\" item.\\n\\n* `FIRST` - the BOGO discount applies to the first\\nmatching item selection in the check or the discount is\\nnot a BOGO discount.\\n\\n* `LEAST_EXPENSIVE` - the BOGO discount applies\\nto the least expensive matching item selection in the check.\\n`LEAST_EXPENSIVE` is the default `itemPickingPriority` value\\nfor discounts that are not BOGO discounts.\\n\\n* `MOST_EXPENSIVE` - the BOGO discount applies to the most\\nexpensive matching item selection in the check.\\n\",\"enum\":[\"FIRST\",\"LEAST_EXPENSIVE\",\"MOST_EXPENSIVE\"]},\"fixedTotal\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The total price of items discounted by a combo\\ndiscount. This value is `null` for discounts that are\\nnot combo discounts.\\n\"},\"promoCodes\":{\"type\":\"array\",\"description\":\"A list of promotion identifiers associated with this discount.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PromoCode\"}}}}]},\"PromoCode\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"Information about a promotion, associated with a discount.\\n\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"The identifier of the promotion. Guests enter the code to apply the discount.\"},\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of the promotion.\"},\"usageType\":{\"type\":\"string\",\"description\":\"Indicates how the promo code can be used.\\n* `SINGLE_USE_PHONE` - the promo code can only be used once per phone number. Some promotional discounts require a guest's phone number when applying the promo code.\\n* `SINGLE_USE_UNIQUE_CODE` - the promo code is a unique code that can only be used once.\\n* `MULTI_USE` - the promo code can be used multiple times.\\n\",\"enum\":[\"SINGLE_USE_PHONE\",\"SINGLE_USE_UNIQUE_CODE\",\"MULTI_USE\"]}}}]},\"Menu\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu as it appears in the Toast POS.\\n\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"groups\":{\"type\":\"array\",\"description\":\"An array of the `MenuGroup` objects\\nthat are part of this menu.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"images\":{\"type\":\"array\",\"description\":\"A collection of images associated with the menu.\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of items in this menu. For example, $10.00 per gram.\\n\\nThe default is `NONE`, which means that the item is not meant to\\nbe measured during a sale.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]}}}]},\"MenuItem\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu item as it appears in the Toast POS.\\n\"},\"calories\":{\"type\":\"integer\",\"description\":\"The amount of food energy in the item, expressed in\\nCalorie units. Values can be positive, negative, or zero.\\n\"},\"sku\":{\"type\":\"string\",\"description\":\"The stock keeping unit (SKU) code for the item.\"},\"plu\":{\"type\":\"string\",\"description\":\"The price look up (PLU) code for the item.\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"type\":{\"type\":\"string\",\"description\":\"Specifies whether this item is a special request or other\\noff-menu transaction.\\n* `NONE` - a normal menu item or modifier.\\n* `OPEN_ITEM` - an item that is not on a menu.\\n* `SPECIAL_REQUEST` - a selection that is not an item.\\n* `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.\\n\",\"enum\":[\"NONE\",\"OPEN_ITEM\",\"SPECIAL_REQUEST\",\"PORTION\"]},\"optionGroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuOptionGroup`s\\nthat contain modifiers applicable to this item. Does not\\ninclude those inherited from the parent `MenuGroup`.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"inheritOptionGroups\":{\"type\":\"boolean\",\"description\":\"True if this menu item inherits `MenuOptionGroup`s\\nfrom its parent `MenuGroup`.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"An array of `Image`\\nobjects that are associated with the `MenuItem`.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of the item.\\nThe default is NONE, which means that the item is not meant to\\nbe measured during a sale.\\nThis value is not relevant if `inheritUnitOfMeasure` is true.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]},\"inheritUnitOfMeasure\":{\"type\":\"boolean\",\"description\":\"True if this menu item inherits its unit of measure\\nfrom its parent `MenuGroup`.\\n\"}}}]},\"MenuGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the menu group as it appears in the Toast POS.\"},\"menu\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"orderableOnline\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates whether restaurant guests can order from the menu online.\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu entity, instead of this\\n`orderableOnline` value, to determine if the entity should be\\navailable for online ordering.\\n\",\"enum\":[\"YES\",\"NO\"]},\"visibility\":{\"type\":\"string\",\"description\":\"Deprecated. Indicates where the menu is displayed and who can see it.\\n* ALL: Visible to everyone (servers and customers)\\n* POS_ONLY: Only visible to servers\\n* NONE: Hidden from everyone\\n\\nUse the `visibility` array that the menus API (V2) returns for each menu\\nentity, instead of this `visibility` value, to determine where the\\nentity should be visible.\\n\",\"enum\":[\"ALL\",\"POS_ONLY\",\"NONE\"]},\"parent\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"items\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuItem`s in the menu\\ngroup.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"subgroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the child `MenuGroup`s in\\nthe menu group. Empty if the menu group does not include any child\\nmenu groups.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"optionGroups\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the child `MenuOptionGroup`s\\nthat contain modifiers applicable to the group, its\\nsubgroups and its items. Does not include\\n`MenuOptionGroup`s inherited from its parent `MenuGroup`.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"inheritOptionGroups\":{\"type\":\"boolean\",\"description\":\"True if this `MenuGroup` inherits `MenuOptionGroup`s\\nfrom its parent `MenuGroup`.\\n\"},\"images\":{\"type\":\"array\",\"description\":\"An array of `Image`\\nobjects associated with with the `MenuGroup`.\\n\",\"items\":{\"$ref\":\"#/components/schemas/Image\"}},\"unitOfMeasure\":{\"type\":\"string\",\"description\":\"The unit of measure used to determine the price of items in this group.\\n\\nThe default is `NONE`, which means that the item is not meant to\\nbe measured during a sale.\\nThis value is not relevant if `inheritUnitOfMeasure` is true.\\n\\nValues are:\\n* `NONE` - The item is not meant to be measured.\\n* `LB` - Weighed in pounds.\\n* `OZ` - Weighed in ounces.\\n* `KG` - Weighed in kilograms.\\n* `G` - Weighed in grams.\\n* `GAL` - Measured in gallons.\\n* `L` - Measured in liters.\\n* `ML` - Measured in milliliters.\\n* `FL_OZ` - Measured in fluid ounces.\\n* `M` - Measured in meters.\\n* `CM` - Measured in centimeters.\\n* `FT` - Measured in feet.\\n* `IN` - Measured in inches.\\n* `YD` - Measured in yards.\\n\",\"enum\":[\"NONE\",\"LB\",\"OZ\",\"KG\",\"G\",\"GAL\",\"L\",\"ML\",\"FL_OZ\",\"M\",\"CM\",\"FT\",\"IN\",\"YD\"]},\"inheritUnitOfMeasure\":{\"type\":\"boolean\",\"description\":\"True if this `MenuGroup` inherits its unit of measure\\nfrom its parent `MenuGroup` or (if its parent is null)\\nits parent `Menu`.\\n\"}}}]},\"MenuOptionGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the `MenuOptionGroup` as it appears in the Toast POS.\"},\"options\":{\"type\":\"array\",\"description\":\"An array of `ExternalReference` objects containing the\\nidentifiers of the `MenuItem`s in\\nthe menu group.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"minSelections\":{\"type\":\"number\",\"format\":\"integer\",\"description\":\"The minimum number of selections that must be made from this option group.\"},\"maxSelections\":{\"type\":\"number\",\"format\":\"integer\",\"description\":\"The maximum number of selections that can be made from this option group.\"}}}]},\"PreModifier\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the pre modifier that appears in the Toast POS.\"},\"scalePrice\":{\"type\":\"boolean\",\"description\":\"True if this multiplies the modifier price, false if it adds to the modifier price.\"},\"basePrice\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Amount to add to the modifier price, if scalePrice is false. Otherwise not used.\"},\"scaleFactor\":{\"type\":\"number\",\"format\":\"float\",\"description\":\"Amount to multiply the modifier price, if scalePrice is true. Otherwise not used.\"},\"displayMode\":{\"type\":\"string\",\"description\":\"Where this premodifier should be displayed relative to the modifier name.\\nPREFIX - before the modifier name\\nSUFFIX - after the modifier name\\n\",\"enum\":[\"PREFIX\",\"SUFFIX\"]},\"parent\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"chargeAsExtra\":{\"type\":\"boolean\",\"description\":\"When true, selecting this pre-modifier adds an additional portion of the modifier to the menu item and adds the price of the additional portion to the menu item according to the rules listed below.\\n\\nIf the modifier group that the modifier belongs to:\\n* Uses the **No charge** option, the Toast platform uses the modifier's <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminBasingModifierOptionsOnExistingMenuItems\\\">override price</a> or, if no override price exists, the <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPricingModifierOptions.html#adminUnderstandingAModifierOptionsItemReference\\\">item reference</a> price as the price of the additional portion.\\n* Uses the **Individual** option where each modifier has its own price, the Toast platform uses the modifier's override price or, if no override price exists, the item reference price as the price of the additional portion.\\n* Uses the **Group** option where all modifiers in the group share a price, the Toast platform uses the group price as the price of the additional portion.\\n\\nAdditionally, if the modifier group that the modifier belongs to uses:\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizePrice.html#adminSizePricingForModifierGroups\\\">Size</a> pricing, the Toast platform uses the size price that matches the size of the menu item when determining the price of the additional portion.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSequencePrice.html\\\">Sequence</a> pricing, the Toast platform treats the additional portion as the next modifier in the sequence and prices it using the sequence pricing rules that have been specified.\\n* <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminSizeSequencePrice.html\\\">Size/sequence</a> pricing, the Toast platform matches the size of the additional portion to the size of the menu item and then treats it as the next modifier in the sequence when determining the price of the additional portion.\\n\\nThe `chargeAsExtra` value is `null` if the value is not set.\\n\",\"nullable\":true}}}]},\"PreModifierGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the pre modifier that appears in the Toast POS.\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"True if this PreModifierGroup is set as the default Group.\\nOnly a single PreModifierGroup can be set as default at one time.\\n\"}}}]},\"NoSaleReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the no sale reason that appears in the Toast POS.\"}}}]},\"PayoutReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The short name of this payout reason.\"}}}]},\"PriceGroup\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this price group.\"}}}]},\"Printer\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this printer.\"}}}]},\"RestaurantService\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this meal service (for example, `Lunch` or\\n`Dinner`).\\n\"}}}]},\"RevenueCenter\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"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.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this revenue center.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of this revenue center.\"}}}]},\"SalesCategory\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"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.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this sales category.\"}}}]},\"ServiceArea\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"A representation of a physical service area, a group of tables, in a restaurant.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this service area.\"},\"revenueCenter\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"ServiceCharge\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"description\":\"Any charge applied to a check for something other than menu item. Typical examples include gratuity and delivery fees.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this service charge.\"},\"amountType\":{\"type\":\"string\",\"description\":\"The type of service charge.\",\"enum\":[\"FIXED\",\"PERCENT\",\"OPEN\"]},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Amount in USD to be applied for `FIXED` type service charges.\"},\"percent\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Percent fee to be applied for `PERCENT` type service\\ncharges, based on pre-discount check amount. Must be a\\nnumber between 0 and 100.\\n\"},\"criteria\":{\"$ref\":\"#/components/schemas/ServiceChargeCriteria\"},\"gratuity\":{\"type\":\"boolean\",\"description\":\"True if the service charge is a gratuity and is assigned to the owner of the check.\"},\"taxable\":{\"type\":\"boolean\",\"description\":\"True if tax should be applied to the service charge.\"},\"applicableTaxes\":{\"type\":\"array\",\"description\":\"A reference to the taxes applied to the service charge, if the service charge is taxable.\",\"items\":{\"$ref\":\"#/components/schemas/TaxRate\"}},\"serviceChargeCalculation\":{\"type\":\"string\",\"description\":\"Defines whether or not the service charge is applied before (PRE) or after (POST) discounts. This field is null for non-percent service charges.\",\"enum\":[\"PRE_DISCOUNT\",\"POST_DISCOUNT\"]},\"destination\":{\"type\":\"string\",\"description\":\"Final recipient of the funds from this service charge.\\n\\n* `RESTAURANT` - The business owner of the restaurant receives the service charge funds.\\n* `SERVER` - Restaurant employees receive the service charge funds e.g. gratuity.\\n* `TOAST` - Toast receives the service charge funds.\\n* `THIRD_PARTY` - A third party receives the service charge funds e.g. fundraising funds go to charity.\\n\",\"enum\":[\"RESTAURANT\",\"SERVER\",\"TOAST\",\"THIRD_PARTY\"]},\"taxInclusive\":{\"type\":\"boolean\",\"description\":\"Supports future functionality.\"},\"taxProrated\":{\"type\":\"boolean\",\"description\":\"Supports future functionality.\"}}}]},\"ServiceChargeCriteria\":{\"description\":\"Describes thresholds for when a service charge should be applied to a check.\",\"properties\":{\"minCheckAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The service charge is only applicable if the pre-discount check is at least this amount.\"},\"delivery\":{\"type\":\"boolean\",\"description\":\"True if the service charge is only applicable for deliveries.\"},\"maxCheckAmount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"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\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The service charge is only applicable to deliveries that are at least this distance. A `null` value means this criteria is inapplicable.\"},\"takeout\":{\"type\":\"boolean\",\"description\":\"Indicates whether the service charge is automatically applied to orders that have the takeout dining option behavior.\"},\"dineIn\":{\"type\":\"boolean\",\"description\":\"Indicates whether the service charge is applied to orders that have the dine-in dining option behavior.\"}}},\"Table\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"Represents a dining table in a restaurant.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The human-readable name of this table as it appears in the POS.\"},\"serviceArea\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"revenueCenter\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}}]},\"TaxRate\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this tax rate.\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"True if this tax rate is the default tax rate.\"},\"rate\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The tax rate value.\\n\\nFor a fixed amount tax rate, is the fixed amount of the tax.\\n\\nFor 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.\\n\\nIf `type` is `NONE`, then `rate` is `null`.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the tax rate.\",\"enum\":[\"PERCENT\",\"FIXED\",\"TABLE\",\"NONE\",\"EXTERNAL\"]},\"roundingType\":{\"type\":\"string\",\"description\":\"The method used to round fractional currency amounts to non-fractional currency amounts.\\n\\nOnly applies to `PERCENT` tax rates. For other tax rate types, `roundingType` is `null`.\\n\\nValid values:\\n\\n* `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.\\n\\n* `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.\\n\\n* `ALWAYS_UP` - Always round up to the next number.\\n\\n* `ALWAYS_DOWN` - Always round down to the next number.\\n\\nFor more details and examples, see <a href=\\\"https://doc.toasttab.com/doc/platformguide/adminPercentTaxRates.html#roundingOptions\\\">Rounding options</a>.\\n\",\"enum\":[\"HALF_UP\",\"HALF_EVEN\",\"ALWAYS_UP\",\"ALWAYS_DOWN\"]},\"taxTable\":{\"type\":\"array\",\"description\":\"An array of `TaxTableRow` objects that define a set of tax amounts that apply to specific sale amount ranges.\",\"items\":{\"$ref\":\"#/components/schemas/TaxTableRow\"}},\"conditionalTaxRates\":{\"type\":\"array\",\"description\":\"An array of `ConditionalTaxRate`\\nobjects that indicate the conditional rates that override\\nthe default `rate` for this `TaxRate` in specific\\nsituations. For example, a conditional rate might\\noverride the default rate when a `TaxRate` is applied for\\na specific dining option, such as takeout.\\n\",\"items\":{\"$ref\":\"#/components/schemas/ConditionalTaxRate\"}}}}]},\"ConditionalTaxRate\":{\"type\":\"object\",\"description\":\"A conditional tax rate that overrides the default `rate`\\nfor a `TaxRate` in\\nspecific situations. For example, a conditional rate\\nmight override the default rate when a `TaxRate` is\\napplied for a specific dining option, such as takeout.\\n\",\"properties\":{\"condition\":{\"description\":\"A string describing the condition for the tax rate\",\"type\":\"string\"},\"rate\":{\"description\":\"The percentage rate of the conditional tax rate\",\"type\":\"number\",\"format\":\"double\"}}},\"TaxTableRow\":{\"type\":\"object\",\"description\":\"A closed sale amount range that corresponds to a specific tax amount in a tax table.\",\"properties\":{\"start\":{\"description\":\"The start of a sale amount range that corresponds to a specific tax amount in a tax table.\",\"type\":\"number\",\"format\":\"currency\"},\"end\":{\"description\":\"The end of a sale amount range that corresponds to a specific tax amount in a tax table.\",\"type\":\"number\",\"format\":\"currency\"},\"tax\":{\"description\":\"The tax amount for the tax table row.\",\"type\":\"number\",\"format\":\"currency\"},\"pattern\":{\"description\":\"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.\",\"type\":\"boolean\"}}},\"TipWithholding\":{\"type\":\"object\",\"description\":\"Information about the way tip withholding is configured for\\na restaurant. Tip withholding is a percentage of employees'\\ncredit card tips and service charges that are paid to\\nemployees as a gratuity that is kept by a restaurant to\\ncover credit card processing fees.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Indicates whether a restaurant location withholds a percent of\\nemployees' credit card tips.\\n\\n* `true` - the location keeps a percent of employees' credit card\\ntips.\\n\\n* `false` - the location does not keep a percent of employees'\\ncredit card tips.\\n\"},\"percentage\":{\"type\":\"number\",\"description\":\"The decimal percentage of credit card tips withheld. If tip\\nwithholding is not `enabled`, tips will not be withheld in the\\nToast platform regardless of this value.\\n\"}}}]},\"VoidReason\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"description\":\"When voiding something through the POS, the user must choose a preconfigured void reason.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of this void reason.\"}}}]},\"Image\":{\"type\":\"object\",\"description\":\"Information about an image associated with a menu or menu item.\",\"properties\":{\"url\":{\"description\":\"The web address of the image.\",\"type\":\"string\"}}},\"ExternalReference\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string, prefixed by the naming authority.\",\"type\":\"string\"}},\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\"}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID.\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast POS.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\",\"type\":\"string\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-config-api.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/configuration/overview/","redocItemId":"tag/Payout-Reasons/operation/payoutReasonsGet","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-config-api.yaml"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"Get payout reasons\n"}}},"pageContext":{"id":"be1a07ef-2b5a-5d3c-88eb-47a17351f8a3operation/payoutReasonsGet__redocly content/configuration/operation/payoutReasonsGet/","seo":{"title":"Get payout reasons\n","description":"Returns an array of `PayoutReason` objects\ncontaining information about recurring cash expenses configured\nfor a restaurant. For example, payment for services such as\nwindow washing might be payout reasons. If a `lastModified`\ndate is specified, returns all objects that were created or\nmodified after that date.\n","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"configuration.reference.page.yaml#operation/payoutReasonsGet","pageBaseUrl":"/configuration","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/configuration/operation/payoutReasonsGet/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"configuration","id":"configuration","title":"configuration","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}