Shift

Description

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	Type	Description	Notes
id	String	UUID for this object	[optional]
employeeId	String	The ID of the employee this shift belongs to.
locationId	String	The ID of the location this shift occurred at. Should be based on where the employee clocked in.	[optional]
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.	[optional]
startAt	String	RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.
endAt	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).	[optional]
wage	ShiftWage	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.	[optional]
breaks	List<ModelBreak>	A list of any paid or unpaid breaks that were taken during this shift.	[optional]
status	String	Describes working state of the current `Shift`. See ShiftStatus for possible values	[optional]
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.	[optional]
createdAt	String	A read-only timestamp in RFC 3339 format; presented in UTC.	[optional]
updatedAt	String	A read-only timestamp in RFC 3339 format; presented in UTC.	[optional]