• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update timecard
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
Effective February 26th, 2020

Modifies the details of a timecard with an API_EDIT event for the timecard.

Updating an active timecard with a clockout_time clocks the employee out.

Permissions
TIMECARDS_WRITE

Deprecation date
2020-02-26
Retirement date
2021-02-26
Replaced by
UpdateShift
Migration guide
Name Description
timecard_id
string

Required

TThe ID of the timecard to modify.

Name Description
id
string

The timecard's unique ID.

employee_id
string

Required

The ID of the employee the timecard is associated with.

deleted
boolean

If true, the timecard was deleted by the merchant, and it is no longer valid.

clockin_time
string

The clock-in time for the timecard, in ISO 8601 format.

clockout_time
string

The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system.

clockin_location_id
string

The ID of the location the employee clocked in from. We strongly reccomend providing a clockinlocationid. Square uses the clockinlocationid to determine a timecard’s timezone and overtime rules.

clockout_location_id
string

The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system.

created_at
string

The time when the timecard was created, in ISO 8601 format.

updated_at
string

The time when the timecard was most recently updated, in ISO 8601 format.

regular_seconds_worked
number

The total number of regular (non-overtime) seconds worked in the timecard.

overtime_seconds_worked
number

The total number of overtime seconds worked in the timecard.

doubletime_seconds_worked
number

The total number of doubletime seconds worked in the timecard.

Response Fields

Name Description
id
string

The timecard's unique ID.

employee_id
string

Required

The ID of the employee the timecard is associated with.

deleted
boolean

If true, the timecard was deleted by the merchant, and it is no longer valid.

clockin_time
string

The clock-in time for the timecard, in ISO 8601 format.

clockout_time
string

The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system.

clockin_location_id
string

The ID of the location the employee clocked in from. We strongly reccomend providing a clockinlocationid. Square uses the clockinlocationid to determine a timecard’s timezone and overtime rules.

clockout_location_id
string

The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system.

created_at
string

The time when the timecard was created, in ISO 8601 format.

updated_at
string

The time when the timecard was most recently updated, in ISO 8601 format.

regular_seconds_worked
number

The total number of regular (non-overtime) seconds worked in the timecard.

overtime_seconds_worked
number

The total number of overtime seconds worked in the timecard.

doubletime_seconds_worked
number

The total number of doubletime seconds worked in the timecard.

Examples

You are viewing an old version of the API
PUT /v1/me/timecards/{timecard_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/me/timecards/timecard_id0 \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

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