TimeEntryBreak

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.

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

• breakType:
  object (ToastReference)

  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.

• inDate:
  string <date-time>

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

• missed:
  boolean

  Indicates whether the break was a missed break.

  • true - The break was missed.
  • false - The break was taken.
• outDate:
  string <date-time>

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

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

{
  "guid": "string",
  "breakType": {
    "guid": "string",
    "entityType": "string"
  },
  "paid": true,
  "inDate": "2019-08-24T14:15:22Z",
  "outDate": "2019-08-24T14:15:22Z",
  "missed": true,
  "auditResponse": true
}