General

General information about a restaurant location.

• archived:
  boolean

  Default: false

  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.

• 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-12 (midnight to noon) in the Business Day Cutoff field in Toast Web.

• currencyCode:
  string

  The ISO-4217 currency code used in this restaurant

• description:
  string

  A description of the restaurant, such as information about the atmosphere and food.

• 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.

• locationCode:
  string

  A code used internally to differentiate multiple locations, typically a 3 or 4 letter code.

• locationName:
  string

  A name used externally to differentiate multiple locations, like Neighborhood, Square, City, or Hotel.

• managementGroupGuid:
  string

  The unique identifier of the restaurant group for the restaurant.

• name:
  string

  The guest-facing name of the restaurant. For example, the name of a restaurant might be Tommy's Burgers.

• timeZone:
  string

  The name of the restaurant's time zone in the IANA time zone database. For example, America/New_York.

{
  "name": "string",
  "locationName": "string",
  "locationCode": "string",
  "description": "string",
  "timeZone": "string",
  "closeoutHour": 0,
  "managementGroupGuid": "string",
  "currencyCode": "string",
  "firstBusinessDate": 0,
  "archived": false
}