<- Object

Object

All versions ->

Timecard

A record of the hourly rate, start time, and end time of a single timecard (shift) for a team member.

This might include a record of the start and end times of breaks taken during the shift.

Link to section

Properties

Link to section

id

string

Read only The Square-issued UUID for this object.

Link to section

location_id

string

Required

The ID of the location for this timecard. The location should be based on where the team member clocked in.

Link to section

timezone

string

Read only The time zone calculated from the location based on the location_id, provided as a convenience value. Format: the IANA time zone database identifier for the location time zone.

Link to section

start_at

string

Required

The start time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.

Link to section

end_at

string

The end time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.

Link to section

wage

Job and pay related information. If the wage is not set on create, it defaults to a wage of zero. If the title is not set on create, it defaults to the name of the role the team member is assigned to, if any.

Link to section

breaks

A list of all the paid or unpaid breaks that were taken during this timecard.

Link to section

status

string

Describes the working state of the timecard.

Link to section

version

integer(32-bit)

Read only The current version of the timecard, which is incremented with each update. This field is used for optimistic concurrency control to ensure that requests don't overwrite data from another request.

Link to section

created_at

string

Read only The timestamp of when the timecard was created, in RFC 3339 format presented as UTC.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

updated_at

string

Read only The timestamp of when the timecard was last updated, in RFC 3339 format presented as UTC.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

team_member_id

string

Required

Link to section

declared_cash_tip_money

The cash tips declared by the team member for this timecard.