Employee

A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID.

• chosenName:
  string

  Optional, chosen name of the employee. To be used, when appropriate, in place of first name.

• createdDate:
  string <date-time>

  Date created, in UTC format (read-only).

• deleted:
  boolean

  If the employee is deleted in the Toast platform.

• deletedDate:
  string <date-time>

  Date deleted, in UTC format (read-only).

• email:
  string

  Employee's email address.

• entityType required:
  string

  The type of object this is.

• externalEmployeeId:
  string

  Optional, employee’s external ID in the Toast platform.

• externalId:
  string

  External identifier string that is prefixed by the naming authority. You can, for example, use the labor API to POST an externalId for an employee and then GET the employee with that externalId.

• firstName:
  string

  Optional, first name of the employee.

• guid required:
  string

  The GUID maintained by the Toast platform.

• jobReferences:
  Array of objects (ExternalReference) >= 0 items

  An array of external references to jobs assigned to this employee. If the job is deleted, it will be excluded from this array.

• lastName:
  string

  Optional, last name of the employee.

• modifiedDate:
  string <date-time>

  Date modified, in UTC format (read-only).

• passcode:
  string

  An optional numeric security code that a new employee can use to begin a session in a Toast POS device. The value must be numeric and it must contain at least one and no more than eight digits. The value must be unique to the location. The employee can only use the passcode at the restaurant specified in the POST request. The response to a successful POST request will include the passcode value in clear text. A GET request for the employee will not return the passcode.

• phoneNumber:
  string

  Employee's phone number

• phoneNumberCountryCode:
  string

  A numeric code corresponding to one or more countries, used as a telephone number prefix when making international telephone calls.

• v2EmployeeGuid:
  string

  This value is included for future use. An alternate Toast platform GUID for the employee that will be used in upcoming labor API functionality.

• wageOverrides:
  Array of objects (JobWageOverride) >= 0 items

  An optional array of per job wage overrides, where each element defines a job reference and the wage override for this employee when performing that job. If the underlying job is deleted, it will be excluded from the array.

{
  "guid": "string",
  "entityType": "string",
  "externalId": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "modifiedDate": "2019-08-24T14:15:22Z",
  "deletedDate": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "chosenName": "string",
  "lastName": "string",
  "email": "string",
  "phoneNumber": "string",
  "phoneNumberCountryCode": "string",
  "passcode": "string",
  "externalEmployeeId": "string",
  "deleted": true,
  "jobReferences": [
    {
      "guid": "string",
      "entityType": "string",
      "externalId": "string"
    }
  ],
  "wageOverrides": [
    {
      "wage": 0,
      "jobReference": {
        "guid": "string",
        "entityType": "string",
        "externalId": "string"
      }
    }
  ],
  "v2EmployeeGuid": "string"
}