TimeEntry

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

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.

Array of objects (TimeEntryBreak) >= 0 items

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.

businessDate
string

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

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.

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.

createdDate
string <date-time>

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

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.

deleted
boolean

If the time entry 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.

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.

inDate
string <date-time>

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

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

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.

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.

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.

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.

overtimeHours
number <double>

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

regularHours
number <double>

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

object (ExternalReference)

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

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.

{
  • "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": {
    },
  • "shiftReference": {
    },
  • "inDate": "2019-08-24T14:15:22Z",
  • "outDate": "2019-08-24T14:15:22Z",
  • "autoClockedOut": true,
  • "businessDate": "string",
  • "regularHours": 0,
  • "overtimeHours": 0,
  • "hourlyWage": 0,
  • "breaks": [
    ],
  • "declaredCashTips": 0,
  • "nonCashTips": 0,
  • "cashGratuityServiceCharges": 0,
  • "nonCashGratuityServiceCharges": 0,
  • "tipsWithheld": 0,
  • "nonCashSales": 0,
  • "cashSales": 0
}