Object Index / Definition

You are viewing an old version of the API
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.

Properties

Name Description
id
string

UUID for this object

Max Length 255
employee_id
string

Required

The ID of the employee this shift belongs to.

Min Length 1
start_at
string

Required

RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.

Min Length 1
breaks
Break [ ]

A list of any paid or unpaid breaks that were taken during this shift.

created_at
string

A read-only timestamp in RFC 3339 format; presented in UTC.

end_at
string

RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The end_at minute is not counted when the shift length is calculated. For example, a shift from 00:00 to 08:01 is considered an 8 hour shift (midnight to 8am).

location_id
string

The ID of the location this shift occurred at. Should be based on where the employee clocked in.

status
string

Describes working state of the current Shift.

timezone
string

Read-only convenience value that is calculated from the location based on location_id. Format: the IANA Timezone Database identifier for the location timezone.

updated_at
string

A read-only timestamp in RFC 3339 format; presented in UTC.

version
integer

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.

wage
Shift​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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?