Shift

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

createdDate
string <date-time>

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

deleted
boolean

If the shift is deleted in the Toast platform.

deletedDate
string <date-time>

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

object (ExternalReference)

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

entityType
required
string

The type of object this is.

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.

guid
required
string

The GUID maintained by the Toast platform.

inDate
string <date-time>

Timestamp of the beginning of the shift. This is when the employee can clock in. Expressed in the UTC time zone.

object (ExternalReference)

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

modifiedDate
string <date-time>

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

outDate
string <date-time>

Timestamp of the end of the shift. This is when the employee can clock out. Expressed in the UTC time zone.

object (ScheduleConfig)

Schedule configuration containing info about the clock in/clock out grace period.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "jobReference": {
    },
  • "employeeReference": {
    },
  • "inDate": "2019-08-24T14:15:22Z",
  • "outDate": "2019-08-24T14:15:22Z",
  • "scheduleConfig": {
    }
}