ModelBreak

March 13, 2019 ยท View on GitHub

Description

A record of an employee's break during a shift.

Properties

NameTypeDescriptionNotes
idStringUUID for this object[optional]
startAtStringRFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated.
endAtStringRFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the break length is calculated. For example, a break from `00:00` to `00:11` is considered a 10 minute break (midnight to 10 minutes after midnight).[optional]
breakTypeIdStringThe `BreakType` this `Break` was templated on.
nameStringA human-readable name.
expectedDurationStringFormat: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break.
isPaidBooleanWhether this break counts towards time worked for compensation purposes.