Toast · JSON Structure

Labor Employee Structure

A restaurant employee

Type: object Properties: 0
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

Employee is a JSON Structure definition published by Toast. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-structure/labor-employee-structure.json",
  "name": "Employee",
  "description": "A restaurant employee",
  "type": "object",
  "definitions": {
    "ExternalReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast \nplatform entity by Toast GUID or an external identifier.\n",
      "allOf": [
        {
          "$ref": "#/$defs/ToastReference"
        },
        {
          "type": "object",
          "properties": {
            "externalId": {
              "description": "External identifier string that is prefixed by the naming \nauthority. You can, for example, use the labor API to \n`POST` an `externalId` for an employee and then `GET` the \nemployee with that `externalId`.\n",
              "type": "string"
            }
          }
        }
      ],
      "name": "ExternalReference"
    },
    "JobWageOverride": {
      "type": "object",
      "description": "The overriding job wage, for an employee that has a wage that \ndiffers from the job's default wage.\n",
      "required": [
        "wage",
        "jobReference"
      ],
      "properties": {
        "wage": {
          "type": "double",
          "description": "Required currency value of the employee's overriding job wage.\n",
          "example": 1.0
        },
        "jobReference": {
          "type": "object",
          "description": "Required external reference to the job to which this wage \napplies overridden\n",
          "$ref": "#/$defs/ExternalReference"
        }
      },
      "name": "JobWageOverride"
    }
  }
}