<- Object

Object

All versions ->

Break

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

Link to section

Properties

Link to section

id

string

The UUID for this object.

Link to section

start_at

string

Required

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Min Length
1
Link to section

end_at

string

RFC 3339; follows the same timezone information as Shift. Precision up to the minute is respected; seconds are truncated.

Link to section

break_type_id

string

Required

The BreakType that this Break was templated on.

Min Length
1
Link to section

name

string

Required

A human-readable name.

Min Length
1
Link to section

expected_duration

string

Required

Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break.

Min Length
1
Link to section

is_paid

boolean

Required

Whether this break counts towards time worked for compensation purposes.