This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

This section provides reference information about the endpoints and data types of the Toast labor API. For more information about using the labor API and code examples, see Getting All Employees of a Restaurant. For general information about working with Toast APIs, see API overview.

Toast Labor API

Base URL: /labor/v1, Version: 1.9.0

Toast labor API is a set of REST web services that you can use to manage the employees, jobs, and shifts for your restaurant. The labor API is intended for software engineers, managers, and technical staff who are responsible for integrating third-party systems with the Toast platform.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Tag: Employees

Operation Description
GET /employees

Get employees

POST /employees

Add an employee

GET /employees/{employeeId}

Get information about one employee

DELETE /employees/{employeeId}

Delete an employee

PATCH /employees/{employeeId}

Update employee information

POST /employees/{employeeId}/externalId

Add an external identifier

PUT /employees/{employeeId}/externalId

Add or replace an external identifier

PUT /employees/{employeeId}/jobs

Replace a jobs list

PUT /employees/{employeeId}/wageOverrides

Replace wage overrides

Tag: Jobs

Operation Description
GET /jobs

Get jobs

GET /jobs/{jobId}

Get one job

POST /jobs/{jobId}/externalId

Add an external identifier

PUT /jobs/{jobId}/externalId

Add or replace an external identifier

Tag: Shifts

Operation Description
GET /shifts

Get shifts

POST /shifts

Create a shift

GET /shifts/{shiftId}

Get a shift

PUT /shifts/{shiftId}

Update a shift

DELETE /shifts/{shiftId}

Delete a shift

Tag: Time entries

Operation Description
GET /timeEntries

Get time entries

GET /timeEntries/{timeEntryId}

Get one time entry

Paths

Get employees

GET /employees

Tags: Employees

Returns an array of Employee objects containing information about restaurant employees.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
employeeIds

An optional identifier that filters return values for a specific employee. The identifier can be a Toast platform GUID or an external identifier. If present, the employees resource will only return the employees you specify. You can include multiple employeeIds query parameters (maximum 100). If not present, the resource returns each employee for the restaurant.

query string (string)

application/json

200 OK

JSON objects for all employees in the restaurant

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Add an employee

POST /employees

Tags: Employees

Creates a restaurant employee record.

Uses default content-types: application/json

An Employee object containing information about the employee, including the employee's name and email address.

{
"chosenName": "optional chosen name",
"email": "email",
"entityType": "RestaurantUser",
"externalEmployeeId": "optional external employee ID",
"externalId": "optional external ID",
"firstName": "first name",
"jobReferences\"": [
{
"entityType": "RestaurantJob",
"guid": "f290a951-2042-4f3d-b861-d89e9e583876"
}
]
,
"lastName": "last name",
"wageOverrides": [
{
"jobReference": {
"entityType": "RestaurantJob",
"guid": "f290a951-2042-4f3d-b861-d89e9e583876"
}
,
"wage": 10
}
]
}
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)

application/json

200 OK

Returns the created employee.

400 Bad Request

The request contains data that is not supported by the current version of the API as described.

415 Unsupported Media Type

The request did not have "application/json" in the Content-Type header.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Delete an employee

DELETE /employees/{employeeId}

Tags: Employees

Deletes a restaurant employee record by marking the record as deleted. A deleted employee cannot log in at the restaurant or open new time entries.

If you GET an employee record that has been deleted, its deleted value is true and its deletedDate value contains the date and time the record was deleted. If you GET all employees for a restaurant, the GUIDs for deleted employees are not included in the return data.

If you delete an employee that has already been deleted then the result is successful (200) and no change is made.

The deleted record appears in the list of deleted employees for the restaurant in the Toast administration back-end. From the list of deleted employees, you can enable a deleted record so that the employee can use it again. You cannot enable a deleted employee using the labor API. Information about deleted employees remains available in reports.

You cannot delete employees who have open time entries (time entries that do not have an out date value).

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
employeeId

The Toast platform GUID or external identifier for the employee to be deleted.

path string

application/json

200 OK

The employee has been deleted. Returns an Employee object containing information about the deleted restaurant employee.

400 Bad Request

The GUID or external identifier was malformed.

404 Not Found

The GUID or external identifier does not match any employees at the current restaurant.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Get information about one employee

GET /employees/{employeeId}

Tags: Employees

Returns an Employee object containing information about one restaurant employee.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
employeeId

The Toast platform GUID or external identifier for the employee to be returned.

path string

application/json

200 OK

Returns the employee information.

400 Bad Request

The GUID or external identifier was malformed.

404 Not Found

The GUID or external identifier does not match any employees at the current restaurant.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Update employee information

PATCH /employees/{employeeId}

Tags: Employees

Updates the first name, chosen name, last name, external employee ID, and/or passcode of a restaurant employee. The PATCH operation cannot update any other employee information.

Uses default content-types: application/json

A JSON object containing the employee information that you are updating. You can update an employee's:

  • firstName - First name.

  • chosenName - Chosen name.

  • lastName - Last name.

  • externalEmployeeId - External employee identifier.

  • passcode - The passcode for access to Toast POS devices.

All values are optional. You must include at least one value. Each value that you include must contain information (not null). If you include the passcode value to update an employee's passcode you must include the employee's current passcode in the currentPasscode value.

{
"chosenName": "Mynewchosenname",
"currentPasscode": "1111",
"externalEmployeeId": "1234567890",
"firstName": "Mynewfirstname",
"lastName": "Mynewlastname",
"passcode": "1234"
}
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
employeeId

The Toast platform GUID or external identifier for the employee to be returned.

path string

application/json

200 OK

Returns the updated Toast platform employee record.

400 Bad Request

The Toast platform GUID or external identifier was malformed, or the body of the request was malformed.

404 Not Found

The Toast platform GUID or external identifier does not match any employees at the current restaurant.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Add an external identifier

POST /employees/{employeeId}/externalId

Tags: Employees

Adds an external identifier for an existing employee. Include the string value of the new external identifier in the message body.

You cannot change an existing external identifier with another POST request; use PUT instead. The Toast platform uses this external identifier as one of the unique, persistent identifiers for an employee record.

Uses default content-types: application/json

The JSON string value of the externalId for the employee record. Wrap the value in double quotation marks to make it valid JSON syntax.

"MyToastNamingAuthority:9876543210"
                                        
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
employeeId

The Toast platform GUID of the employee record.

path string

application/json

200 OK

Returns the updated employee record.

Add or replace an external identifier

PUT /employees/{employeeId}/externalId

Tags: Employees

Adds or replaces the external identifier for an existing employee. Include the string value of the new external identifier in the message body.

The Toast platform uses this external identifier as one of the unique, persistent identifiers for an employee record. Changing the external identifier for an existing employee might affect reporting and other Toast platform functions that select employees using the externalId value.

Uses default content-types: application/json

The JSON string value of the externalId for the employee record. Wrap the value in double quotation marks to make it valid JSON syntax.

"MyToastNamingAuthority:9876543210"
                                        
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
employeeId

The Toast platform GUID of the employee record.

path string

application/json

200 OK

Returns the updated employee record.

Replace a jobs list

PUT /employees/{employeeId}/jobs

Tags: Employees

Replaces the list of jobs for an employee. Include a JSON
array of job identifiers in the message body.

If a job is defined at the restaurant group or subgroup level, this operation adds or removes that job for the the employee at all restaurant locations in the group or subgroup.

Uses default content-types: application/json

An array of JSON objects containing identifiers for jobs. The identifiers can be either Toast platform GUIDs or external identifiers.

[
{
"guid": "dd8cea7a-add5-4508-b8fe-ffd0b584e4da"
},
{
"externalId": "MyToastNamingAuthority:9876543210"
}
]
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
employeeId

The Toast platform GUID of the employee record.

path string

application/json

200 OK

Returns the updated employee record.

Replace wage overrides

PUT /employees/{employeeId}/wageOverrides

Tags: Employees

Replaces the list of wage overrides for the jobs that are assigned to an employee. Include a JSON array of JobWageOverride objects in the message body. Include the new wage for the employee in the wage value. Specify the wage in U.S. dollars.

You must include all existing wage overrides in the message body. Any wage overrides that are not present in the array are removed from the employee record.

Uses default content-types: application/json

An array of JSON JobWageOverride objects.

[
{
"jobReference": {
"guid": "8d3bba92-10e4-4345-9ae6-ed94c09dc332"
}
,
"wage": 15.75
}
]
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
employeeId

The Toast platform GUID of the employee record.

path string

application/json

200 OK

The wage overrides for the employee are replaced. Returns the updated employee record.

Get jobs

GET /jobs

Tags: Jobs

Returns an array of Job objects containing information about the employee jobs configured at a restaurant.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
jobIds

An optional array of one or more job identifiers, either the Toast platform GUID or an external identifier assigned by the client. 100 max. If not provided, all jobs known to the Toast platform for this restaurant will be returned.

query string[]

application/json

200 OK

Returns the specified jobs.

Job
500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Get one job

GET /jobs/{jobId}

Tags: Jobs

Returns a Job object containing information about one employee job at a restaurant.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
jobId

The Toast platform GUID or an external identifier for the job.

path string (string)

application/json

200 OK

Returns the specified job.

Job
400 Bad Request

The Toast platform GUID or external identifier was malformed.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Add an external identifier

POST /jobs/{jobId}/externalId

Tags: Jobs

Adds an external identifier for an existing job. Include the string value of the new external identifier in the message body.

You cannot change an existing external identifier with another POST request. The Toast platform uses this external identifier as one of the unique, persistent identifiers for a job record.

Uses default content-types: application/json

The JSON string value of the externalId for the job record. Wrap the value in double quotation marks to make it valid JSON syntax.

"MyToastNamingAuthority:9876543210"
                                        
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
jobId

The Toast platform GUID or external identifier of the job record.

path string

application/json

200 OK

Returns the updated job record.

Job
Add or replace an external identifier

PUT /jobs/{jobId}/externalId

Tags: Jobs

Adds or replaces the external identifier for an existing job. Include the string value of the new external identifier in the message body.

The Toast platform uses this external identifier as one of the unique, persistent identifiers for a job record. Changing the external identifier for an existing job might affect reporting and other Toast platform functions that select jobs using the externalId value.

Uses default content-types: application/json

The JSON string value of the externalId for the job record. Wrap the value in double quotation marks to make it valid JSON syntax.

"MyToastNamingAuthority:9876543210"
                                        
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)
jobId

The Toast platform GUID or external identifier of the job record.

path string

application/json

200 OK

Returns the updated job record.

Job
Get shifts

GET /shifts

Tags: Shifts

Returns an array of Shift objects that contain information about schedule shifts for restaurant employees.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
shiftIds

An optional identifier that filters return values for a specific shift. The identifier can be a Toast platform GUID or an external identifier. If present, the shifts resource will only return the shifts you specify. You can include multiple shiftIds query parameters (maximum 100).

query string (string)
startDate

Optional start date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified startDate and the shift outDate is before the endDate (exclusive). These parameters are required if the shiftIds parameter is not defined. The specified period cannot be longer than one month.

query string (ISO-8601)
endDate

Optional end date and time of time period to match shifts. A shift matches the time period if the shift inDate is after (inclusive) the specified startDate and the shift outDate is before the endDate (exclusive). These parameters are required if the shiftIds parameter is not defined. The specified period cannot be longer than one month.

query string (ISO-8601)

application/json

200 OK

Returns the specified shifts in an unordered list.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Create a shift

POST /shifts

Tags: Shifts

Creates a schedule shift for a restaurant employee.

Uses default content-types: application/json

A Shift object containing information about the shift, including the job identifier, the employee identifier, and the start and end times.

{
"employeeReference": {
"entityType": "RestaurantUser",
"externalId": "",
"guid": "7030407f-761c-4d92-86d9-4e84bc700d0f"
}
,
"entityType": "Shift",
"externalId": "MyToastNamingAuthority:1234",
"inDate": "2015-10-10T06:00:00.000+0000",
"jobReference": {
"entityType": "RestaurantJob",
"externalId": "",
"guid": "678758d1-6aa8-494c-be55-0614f761d160"
}
,
"outDate": "2015-10-10T12:00:00.000+0000"
}
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
Content-Type

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

header string (string)

application/json

200 OK

Creates a shift record and returns information about it.

400 Bad Request

The request contains data that is not supported by the current version of the API as described.

415 Unsupported Media Type

The request did not have "application/json" in the Content-Type header.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Delete a shift

DELETE /shifts/{shiftId}

Tags: Shifts

Marks an existing schedule shift record for a restaurant employee as deleted. If the shift record was already deleted, then the operation will succeed (HTTP 200 response code) and no change will be made.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
shiftId

The shift identifier, either the Toast platform GUID or an external identifier.

path string (string)

application/json

200 OK

Returns the specified shift, with the deleted flag set to true.

400 Bad Request

The Toast platform GUID or external identifier was malformed.

404 Not Found

The Toast platform GUID or external identifier does not match any shifts at the current restaurant.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Get a shift

GET /shifts/{shiftId}

Tags: Shifts

Returns a Shift object containing of information about one schedule shift for a restaurant employee.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
shiftId

The Toast platform GUID or an external identifier for the shift.

path string

application/json

200 OK

Returns the specified shifts in an unordered list.

400 Bad Request

The GUID or external identifier was malformed.

404 Not Found

The GUID or external identifier does not match any shifts at the current restaurant.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Update a shift

PUT /shifts/{shiftId}

Tags: Shifts

Updates an existing schedule shift record for a restaurant employee. A PUT request completely replaces the information in the existing record.

Uses default content-types: application/json

The shift information. The externalId identifier is not allowed forPUT requests.

{
"employeeReference": {
"entityType": "RestaurantUser",
"externalId": "",
"guid": "7030407f-761c-4d92-86d9-4e84bc700d0f"
}
,
"entityType": "Shift",
"inDate": "2015-10-10T06:00:00.000+0000",
"jobReference": {
"entityType": "RestaurantJob",
"externalId": "",
"guid": "678758d1-6aa8-494c-be55-0614f761d160"
}
,
"outDate": "2015-10-10T12:00:00.000+0000"
}
Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
shiftId

The shift identifier, either the Toast platform GUID or an external identifier.

path string (string)

application/json

200 OK

Returns the updated Shift.

400 Bad Request

The request contains data that is not supported by the current version of the API as described.

404 Not Found

The GUID or external identifier does not match any shifts at the current restaurant.

415 Unsupported Media Type

The request did not have application/json in the Content-Type header.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Get time entries

GET /timeEntries

Tags: Time entries

Returns an array of TimeEntry objects that contain information about employee shift events. The information includes shift start times, end times, and the start and end times of break periods.

  • Include one or more timeEntryId query parameters set to the GUIDs for specific time entries.

  • Include both a startDate and an endDate query parameter to get time entries for a specific time period.

  • Include both a modifiedStartDate and a modifiedEndDate query parameter to get the time entries that were modified during a specific time period.

  • Includes a businessDate query parameter to get the time entries with an inDate during a specific business date.

Valid requests include one or more timeEntryId parameters, both a startDate and an endDate, both a modifiedStartDate and a modifiedEndDate, or a businessDate.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
timeEntryIds

Optional array of one or more time entry identifiers, either the Toast platform GUID or an external identifier. 100 max.

query string[]
startDate

Optional start date and time of time period to match time entries. A time entry matches the time period if its clock-in inDate is after (inclusive) the specified startDate and before (exclusive) the endDate. The specified period cannot be longer than one month.

query string (ISO-8601)
endDate

Optional end date and time of time period to match time entries. A time entry matches the time period if its clock-in inDate is after (inclusive) the specified startDate and before (exclusive) the endDate. The specified period cannot be longer than one month.

query string (ISO-8601)
modifiedStartDate

Start date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified after (inclusive) the modifiedStartDate. If you include this parameter, you must also include the modifiedEndDate parameter. The specified period cannot be longer than one month.

query string (ISO-8601)
modifiedEndDate

End date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified before (exclusive) the modifiedEndDate. If you include this parameter, you must also include the modifiedStartDate parameter. The specified period cannot be longer than one month.

query string (ISO-8601)
businessDate

Optional date to match time entries. A time entry matches the business date if its clock-in inDate is during the business date. The cutoff from one businessDate to the next is the closeoutHour for the restaurant.

query string (yyyymmdd)
includeMissedBreaks

Optional flag to indicate whether missed breaks should be returned in the breaks array for the time entries.

query boolean

application/json

200 OK

Returns the specified time entries.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Get one time entry

GET /timeEntries/{timeEntryId}

Tags: Time entries

Returns a TimeEntry object containing information about one employee shift. The information includes the shift start time, end time, and the start and end times of break periods.

Toast-Restaurant-External-ID

The Toast platform GUID of the restaurant that is the context for this operation.

header string (string)
timeEntryId

The Toast platform GUID or an external identifier for the time entry.

path string (string)
includeMissedBreaks

Optional flag to indicate whether missed breaks should be returned in the breaks array for the time entries.

query boolean
includeArchived

Controls whether the response includes an archived time entry. Optional.

query boolean

application/json

200 OK

Returns the specified time entry.

400 Bad Request

The GUID or external identifier was malformed.

500 Internal Server Error

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

Schema definitions

Employee:

A restaurant employee

createdDate: string (date-time)

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

modifiedDate: string (date-time)

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

deletedDate: string (date-time)

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

firstName: string

Optional, first name of the employee.

chosenName: string

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

lastName: string

Optional, last name of the employee.

email: string

Employee's email address.

phoneNumber: string

Employee's phone number

passcode: string

An optional numeric security code that a new employee can use to begin a session in a Toast POS device. The passcode value can only occur in POST requests. The value must be numeric and it must contain at least one and no more than eight digits. 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.

externalEmployeeId: string

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

deleted: boolean

If the employee is deleted in the Toast platform.

disabled: boolean

An employee's Toast platform account may be disabled if that employee is suspected of fraud or other behavior against the terms of service. If true, no shifts should be scheduled for this employee.

jobReferences: object[]

An array of external references to jobs assigned to this employee.

wageOverrides: object[]

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.

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.

ExternalReference:

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

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.

Job:

A restaurant job.

createdDate: string (date-time)

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

modifiedDate: string (date-time)

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

deletedDate: string (date-time)

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

title: string

Title of the job.

deleted: boolean

If the job is deleted in the Toast platform.

wageFrequency: string , x ∈ { HOURLY , SALARY }

An enumerated type specifying how to interpret the default wage for this job.

defaultWage: number (double)

The default wage of the job.

tipped: boolean

Indicates whether the job receives gratuities (tips).

code: string

A reference identifier for the job. This is an optional field entered when the job is created. For example, it can be used to match Toast platform jobs to jobs configured in external labor management systems.

JobWageOverride: object

The overriding job wage, for an employee that has a wage that differs from the job's default wage.

wage: number (double)

Required currency value of the employee's overriding job wage.

jobReference: ExternalReference

Required external reference to the job to which this wage applies overridden

Shift:

A scheduled shift in the Toast platform used to enforce employee clock-in and clock outs. Shifts might be created in an external scheduling system and pushed to the Toast platform.

createdDate: string (date-time)

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

modifiedDate: string (date-time)

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

deletedDate: string (date-time)

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

deleted: boolean

If the shift is deleted in the Toast platform.

jobReference: ExternalReference

External reference to the job assigned to this shift.

employeeReference: ExternalReference

External reference to the employee assigned to this shift.

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.

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.

TimeEntry:

A TimeEntry captures the actual time an employee worked or took a break. Typically, a time entry is one-to-one with a scheduled shift, but it is possible in the Toast platform for an employee to clock-in and clock-out without a shift.

createdDate: string (date-time)

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

modifiedDate: string (date-time)

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

deletedDate: string (date-time)

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

deleted: boolean

If the time entry is deleted in the Toast platform.

jobReference: ExternalReference

Optional, external reference to the job the employee assumed when clocking into the Toast platform.

employeeReference: ExternalReference

External reference to the employee that created this time entry.

shiftReference: ExternalReference

Optional, external reference to the scheduled shift associated with this time entry.

inDate: string (date-time)

The date and time that an employee clocked in to a work shift.

outDate: string (date-time)

The date and time that an employee closed a work shift. If the employee has not closed the shift this field is null.

autoClockedOut: boolean

Indicates whether the Toast platform automatically clocked the employee out of their shift at the end of the restaurant business day. For more information, see the Toast platform guide section about automatic clock-out and time entries.

businessDate: string

The business date of inDate, in the format of "yyyymmdd".

regularHours: number (double)

Regular hours worked by the employee for this time entry, excluding breaks.

overtimeHours: number (double)

Any overtime hours taken by this employee during this time entry.

hourlyWage: number (double)

Optional, historical hourlyWage; that is, the wage in effect when the time entry was made. The current hourlyWage for the employee (or job) may be different. This will be null if the job is SALARY.

breaks: object[]

An optional array of time entry breaks, each break defining a clock-in date, clock-out date, and whether or not the break was paid.

declaredCashTips: number (double)

The currency amount of tips paid in cash during the time entry. This does not include service charges applied as automatic gratuities. If the employee has not closed the shift, this value is not final and may change. If the outDate value is set, the declaredCashTips value is final.

nonCashTips: number (double)

The currency amount of tips paid using non-cash tender during the time entry. For example, this includes credit card tips. This does not include service charges applied as automatic gratuities. If the employee has not closed the shift, this value is not final and may change. If the outDate value is set, the nonCashTips value is final.

cashGratuityServiceCharges: number (double)

The currency amount of service charges applied as automatic gratuities that were paid in cash during the time entry. If the employee has not closed the shift, this value is not final and may change. If the outDate value is set, the cashGratuityServiceCharges value is final.

nonCashGratuityServiceCharges: number (double)

The currency amount of service charges applied as automatic gratuities that were paid using non-cash tender during the time entry. If the employee has not closed the shift, this value is not final and may change. If the outDate value is set, the nonCashGratuityServiceCharges value is final.

tipsWithheld: number (double)

The currency amount withheld from the employee's credit card tips during the time entry. The amount withheld is calculated as a percentage of tips added to credit card payments. If the employee has not closed the shift (the outDate value is null), the tipsWithheld value is not final and may change. If the employee has closed the shift (the outDate value is set), the tipsWithheld value is final.

nonCashSales: number (double)

The currency amount of non-cash sales during the time entry. The value includes the order amounts and tax. It does not include tips.

If the employee has not closed the shift, this value is 0. If the outDate value is set, then the nonCashSales value is final.

cashSales: number (double)

The currency amount of sales paid for in cash during the time entry. The value includes the order amounts and tax. It does not include tips.

If the employee has not closed the shift, this value is 0. If the outDate value is set, then the cashSales value is final.

TimeEntryBreak: object

Information about a period of time that an employee is not working during a shift. For example, an employee might take a break to eat at some time during a shift. An employee can be paid or unpaid for the break period.

guid: string

The GUID maintained by the Toast platform.

breakType: ToastReference

Optional, Toast platform reference to the break type associated with this time entry.

paid: boolean

Indicates whether the employee was paid for the break.

  • true - The break was a paid break.
  • false - The break was an unpaid break.
inDate: string (date-time)

The date and time that the employee started the break period, in UTC.

outDate: string (date-time)

The date and time that the employee ended the break period and returned to work, in UTC.

missed: boolean

Indicates whether the break was a missed break.

  • true - The break was missed.
  • false - The break was taken.
auditResponse: boolean

Indicates whether the employee was asked to take the break.

  • true - The employee was asked to take the break.
  • false - The employee was not asked to take the break.

Null for break types that do not use break acknowledgement tracking or when the employee did not complete the audit response prompt.

ToastReference: object

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

guid: string

The GUID maintained by the Toast platform.

entityType: string

The type of object this is.