Shift
November 20, 2019 ยท View on GitHub
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 | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| id | getId() | setId($value) | string | UUID for this object | [optional] |
| employee_id | getEmployeeId() | setEmployeeId($value) | string | The ID of the employee this shift belongs to. | |
| location_id | getLocationId() | setLocationId($value) | string | The ID of the location this shift occurred at. Should be based on where the employee clocked in. | [optional] |
| timezone | getTimezone() | setTimezone($value) | 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] |
| start_at | getStartAt() | setStartAt($value) | string | RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. | |
| end_at | getEndAt() | setEndAt($value) | 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 | getWage() | setWage($value) | \SquareConnect\Model\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 | getBreaks() | setBreaks($value) | \SquareConnect\Model\ModelBreak[] | A list of any paid or unpaid breaks that were taken during this shift. | [optional] |
| status | getStatus() | setStatus($value) | string | Describes working state of the current `Shift`. See ShiftStatus for possible values | [optional] |
| version | getVersion() | setVersion($value) | int | 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] |
| created_at | getCreatedAt() | setCreatedAt($value) | string | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional] |
| updated_at | getUpdatedAt() | setUpdatedAt($value) | string | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional] |
Note: All properties are protected and only accessed via getters and setters.