Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 3.19 KB

shift.md

File metadata and controls

52 lines (43 loc) · 3.19 KB
Raw

Shift

A record of the hourly rate, start, and end times for a single work shift for an employee. This might 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 The 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 Required The ID of the location this shift occurred at. The location should be based on
where the employee clocked in.
Constraints: Minimum Length: 1
timezone String Optional The read-only convenience value that is calculated from the location based
on the location_id. Format: the IANA timezone database identifier for the
location timezone.
start_at String Required RFC 3339; shifted to the 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 the timezone + offset. Precision up to the minute is
respected; seconds are truncated.
wage Shift Wage Hash Optional The hourly wage rate used to compensate an employee for this shift.
breaks Array<Break Hash> Optional A list of all the paid or unpaid breaks that were taken during this shift.
status String (Shift Status) Optional Enumerates the possible status of a Shift.
version Integer Optional Used for resolving concurrency issues. The request fails if the version
provided does not match the server version at the time of the 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".
declared_cash_tip_money Money Hash Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.

Example (as JSON)

{
  "id": "id0",
  "employee_id": "employee_id0",
  "location_id": "location_id4",
  "timezone": "timezone0",
  "start_at": "start_at2",
  "end_at": "end_at0",
  "wage": {
    "title": "title8",
    "hourly_rate": {
      "amount": 172,
      "currency": "OMR"
    },
    "job_id": "job_id0",
    "tip_eligible": false
  }
}