Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 4.06 KB

shift.md

File metadata and controls

52 lines (43 loc) · 4.06 KB

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 Getter Setter
id ?string Optional The UUID for this object.
Constraints: Maximum Length: 255		 getId(): ?string setId(?string id): void
employeeId ?string Optional The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use team_member_id instead. getEmployeeId(): ?string setEmployeeId(?string employeeId): void
locationId 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		 getLocationId(): string setLocationId(string locationId): void
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.		 getTimezone(): ?string setTimezone(?string timezone): void
startAt string Required RFC 3339; shifted to the location timezone + offset. Precision up to the
minute is respected; seconds are truncated.
Constraints: Minimum Length: 1		 getStartAt(): string setStartAt(string startAt): void
endAt ?string Optional RFC 3339; shifted to the timezone + offset. Precision up to the minute is
respected; seconds are truncated.		 getEndAt(): ?string setEndAt(?string endAt): void
wage ?ShiftWage Optional The hourly wage rate used to compensate an employee for this shift. getWage(): ?ShiftWage setWage(?ShiftWage wage): void
breaks ?(MBreak[]) Optional A list of all the paid or unpaid breaks that were taken during this shift. getBreaks(): ?array setBreaks(?array breaks): void
status ?string(ShiftStatus) Optional Enumerates the possible status of a Shift. getStatus(): ?string setStatus(?string status): void
version ?int 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.		 getVersion(): ?int setVersion(?int version): void
createdAt ?string Optional A read-only timestamp in RFC 3339 format; presented in UTC. getCreatedAt(): ?string setCreatedAt(?string createdAt): void
updatedAt ?string Optional A read-only timestamp in RFC 3339 format; presented in UTC. getUpdatedAt(): ?string setUpdatedAt(?string updatedAt): void
teamMemberId ?string Optional The ID of the team member this shift belongs to. Replaced employee_id at version "2020-08-26". getTeamMemberId(): ?string setTeamMemberId(?string teamMemberId): void
declaredCashTipMoney ?Money 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.		 getDeclaredCashTipMoney(): ?Money setDeclaredCashTipMoney(?Money declaredCashTipMoney): void

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": "LAK"
    },
    "job_id": "job_id0",
    "tip_eligible": false
  }
}