Skip to content

shift.md

Latest commit

 

History

History
42 lines (33 loc) · 2.37 KB

shift.md

File metadata and controls

42 lines (33 loc) · 2.37 KB
Raw

Shift

A record of the hourly rate, start, and end times for a single work shift for an employee. May include a record of the start and end times for breaks taken during the shift.

Structure

Shift

Fields

Name Type Tags Description
id string Optional UUID for this object
Constraints: Maximum Length: 255
employee_id string Optional The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use team_member_id instead
location_id string Optional The ID of the location this shift occurred at. Should be based on
where the employee clocked in.
timezone string Optional Read-only convenience value that is calculated from the location based
on location_id. Format: the IANA Timezone Database identifier for the
location timezone.
start_at string Required RFC 3339; shifted to location timezone + offset. Precision up to the
minute is respected; seconds are truncated.
Constraints: Minimum Length: 1
end_at string Optional RFC 3339; shifted to timezone + offset. Precision up to the minute is
respected; seconds are truncated.
wage Shift Wage Optional The hourly wage rate used to compensate an employee for this shift.
breaks List of Break Optional A list of any paid or unpaid breaks that were taken during this shift.
status str (Shift Status) Optional Enumerates the possible status of a Shift
version int Optional Used for resolving concurrency issues; request will fail if version
provided does not match server version at time of request. If not provided,
Square executes a blind write; potentially overwriting data from another
write.
created_at string Optional A read-only timestamp in RFC 3339 format; presented in UTC.
updated_at string Optional A read-only timestamp in RFC 3339 format; presented in UTC.
team_member_id string Optional The ID of the team member this shift belongs to. Replaced employee_id at version "2020-08-26"

Example (as JSON)

{
  "id": "id0",
  "employee_id": "employee_id0",
  "location_id": "location_id4",
  "timezone": "timezone0",
  "start_at": "start_at2",
  "end_at": "end_at0"
}