Object Index
You are viewing an old version of the API
Shift
Object Index
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.
Properties
| Name | Description |
|---|---|
id
|
UUID for this object |
employee_id
Required
|
The ID of the employee this shift belongs to. |
location_id
|
The ID of the location this shift occurred at. Should be based on where the employee clocked in. |
timezone
|
Read-only convenience value that is calculated from the location based
on |
start_at
Required
|
RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. |
end_at
|
RFC 3339; shifted to timezone + offset. Precision up to the minute is
respected; seconds are truncated. The |
wage
|
Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. |
breaks
|
A list of any paid or unpaid breaks that were taken during this shift. |
status
|
Describes working state of the current |
version
|
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
|
A read-only timestamp in RFC 3339 format; presented in UTC. Examples for January 25th, 2020 6:27.34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
updated_at
|
A read-only timestamp in RFC 3339 format; presented in UTC. Examples for January 25th, 2020 6:27.34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |