ModelBreak

March 13, 2019 ยท View on GitHub

Description

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

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringUUID for this object[optional]
start_atgetStartAt()setStartAt($value)stringRFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated.
end_atgetEndAt()setEndAt($value)stringRFC 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]
break_type_idgetBreakTypeId()setBreakTypeId($value)stringThe `BreakType` this `Break` was templated on.
namegetName()setName($value)stringA human-readable name.
expected_durationgetExpectedDuration()setExpectedDuration($value)stringFormat: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break.
is_paidgetIsPaid()setIsPaid($value)boolWhether this break counts towards time worked for compensation purposes.

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]