Toast · Schema

General

General information about a restaurant location.

RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

Properties

Name	Type	Description
name	string	The guest-facing name of the restaurant. For example, the `name` of a restaurant might be `Tommy's Burgers`.
locationName	string	A name used externally to differentiate multiple locations, like Neighborhood, Square, City, or Hotel.
locationCode	string	A code used internally to differentiate multiple locations, typically a 3 or 4 letter code.
description	string	A description of the restaurant, such as information about the atmosphere and food.
timeZone	string	The name of the restaurant's time zone in the IANA time zone database. For example, `America/New_York`.
closeoutHour	integer	The hour of the day that separates one business day from the next, also known as the "business day cutoff time". This is in the time zone of the restaurant. The `closeoutHour` is set to a value from 0
managementGroupGuid	string	The unique identifier of the restaurant group for the restaurant.
currencyCode	string	The ISO-4217 currency code used in this restaurant
firstBusinessDate	integer	The first business date (yyyyMMdd) is the day a restaurant began using the Toast platform. The `firstBusinessDate` is also the first day on which time entries can be created for employees.
archived	boolean	Returns `true` if the restaurant has been archived from the Toast platform, otherwise returns `false`. A common reason for archiving a restaurant is if the restaurant was created in error.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/restaurants-general-schema.json",
  "title": "General",
  "description": "General information about a restaurant location.\n",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The guest-facing name of the restaurant. For example, the\n`name` of a restaurant might be `Tommy's Burgers`.\n",
      "example": "Example Name"
    },
    "locationName": {
      "type": "string",
      "description": "A name used externally to differentiate multiple locations, like Neighborhood, Square, City, or Hotel.",
      "example": "Example Name"
    },
    "locationCode": {
      "type": "string",
      "description": "A code used internally to differentiate multiple locations, typically a 3 or 4 letter code.",
      "example": "string"
    },
    "description": {
      "type": "string",
      "description": "A description of the restaurant, such as information about the atmosphere and food.",
      "example": "string"
    },
    "timeZone": {
      "type": "string",
      "description": "The name of the restaurant's time zone in the <a \nhref=\"https://www.iana.org/time-zones\">IANA time zone \ndatabase</a>. For example, `America/New_York`.\n",
      "example": "string"
    },
    "closeoutHour": {
      "type": "integer",
      "description": "The hour of the day that separates one business day from the\nnext, also known as the \"business day cutoff time\". This is \nin the time zone of the restaurant. The `closeoutHour` is set \nto a value from 0-12 (midnight to noon) in the Business Day \nCutoff field in Toast Web.\n",
      "example": 1
    },
    "managementGroupGuid": {
      "type": "string",
      "description": "The unique identifier of the restaurant group for the restaurant.",
      "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
    },
    "currencyCode": {
      "type": "string",
      "description": "The ISO-4217 currency code used in this restaurant",
      "example": "string"
    },
    "firstBusinessDate": {
      "type": "integer",
      "description": "The first business date (yyyyMMdd) is the day a restaurant began using the Toast platform. The\n`firstBusinessDate` is also the first day on which time entries can be created for employees.\n",
      "example": "2026-06-03T12:00:00.000+0000"
    },
    "archived": {
      "type": "boolean",
      "description": "Returns `true` if the restaurant has been archived from the Toast platform, otherwise returns `false`. A\ncommon reason for archiving a restaurant is if the restaurant was created in error.\n",
      "default": false,
      "example": true
    }
  }
}