Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 2.61 KB

shift.md

File metadata and controls

41 lines (33 loc) · 2.61 KB

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 Getter
Id String Optional UUID for this object String getId()
EmployeeId String Optional The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use team_member_id instead String getEmployeeId()
LocationId String Optional The ID of the location this shift occurred at. Should be based on
where the employee clocked in.		 String getLocationId()
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.		 String getTimezone()
StartAt String RFC 3339; shifted to location timezone + offset. Precision up to the
minute is respected; seconds are truncated.		 String getStartAt()
EndAt String Optional RFC 3339; shifted to timezone + offset. Precision up to the minute is
respected; seconds are truncated.		 String getEndAt()
Wage ShiftWage Optional The hourly wage rate used to compensate an employee for this shift. ShiftWage getWage()
Breaks List<Break> Optional A list of any paid or unpaid breaks that were taken during this shift. List getBreaks()
Status String Optional Enumerates the possible status of a Shift String getStatus()
Version Integer 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.		 Integer getVersion()
CreatedAt String Optional A read-only timestamp in RFC 3339 format; presented in UTC. String getCreatedAt()
UpdatedAt String Optional A read-only timestamp in RFC 3339 format; presented in UTC. String getUpdatedAt()
TeamMemberId String Optional The ID of the team member this shift belongs to. Replaced employee_id at version "2020-08-26" String getTeamMemberId()

Example (as JSON)

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