Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.73 KB

m-break.md

File metadata and controls

35 lines (26 loc) · 1.73 KB

M Break

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

Structure

MBreak

Fields

Name Type Tags Description Getter Setter
id ?string Optional The UUID for this object. getId(): ?string setId(?string id): void
startAt 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		 getStartAt(): string setStartAt(string startAt): void
endAt ?string Optional RFC 3339; follows the same timezone information as Shift. Precision up to
the minute is respected; seconds are truncated.		 getEndAt(): ?string setEndAt(?string endAt): void
breakTypeId string Required The BreakType that this Break was templated on.
Constraints: Minimum Length: 1		 getBreakTypeId(): string setBreakTypeId(string breakTypeId): void
name string Required A human-readable name.
Constraints: Minimum Length: 1		 getName(): string setName(string name): void
expectedDuration 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		 getExpectedDuration(): string setExpectedDuration(string expectedDuration): void
isPaid bool Required Whether this break counts towards time worked for compensation
purposes.		 getIsPaid(): bool setIsPaid(bool isPaid): void

Example (as JSON)

{
  "id": "id6",
  "start_at": "start_at8",
  "end_at": "end_at4",
  "break_type_id": "break_type_id2",
  "name": "name6",
  "expected_duration": "expected_duration8",
  "is_paid": false
}