Skip to content

break.md

Latest commit

 

History

History
35 lines (26 loc) · 1.3 KB

break.md

File metadata and controls

35 lines (26 loc) · 1.3 KB

Break

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

Structure

Break

Fields

Name Type Tags Description
id string Optional The UUID for this object.
start_at string Required RFC 3339; follows the same timezone information as Shift. Precision up to
the minute is respected; seconds are truncated.
Constraints: Minimum Length: 1
end_at string Optional RFC 3339; follows the same timezone information as Shift. Precision up to
the minute is respected; seconds are truncated.
break_type_id string Required The BreakType that this Break was templated on.
Constraints: Minimum Length: 1
name string Required A human-readable name.
Constraints: Minimum Length: 1
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.
Constraints: Minimum Length: 1
is_paid bool Required Whether this break counts towards time worked for compensation
purposes.

Example (as JSON)

{
  "id": "id0",
  "start_at": "start_at2",
  "end_at": "end_at0",
  "break_type_id": "break_type_id6",
  "name": "name0",
  "expected_duration": "expected_duration4",
  "is_paid": false
}