Create timecard
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.
Creates a timecard for an employee and clocks them in with an
API_CREATE event and a clockin_time set to the current time unless
the request provides a different value.
- Deprecation date: 2020-02-26
- Retirement date: 2021-02-26
- Migration guide
To import timecards from another
system (rather than clocking someone in). Specify the clockin_time
and* clockout_time in the request.
Timecards correspond to exactly one shift for a given employee, bounded
by the clockin_time and clockout_time fields. An employee is
considered clocked in if they have a timecard that doesn't have a
clockout_time set. An employee that is currently clocked in cannot
be clocked in a second time.
Request Body
| Name | Description |
|---|---|
id
|
The timecard's unique ID. |
employee_id
Required
|
The ID of the employee the timecard is associated with. |
deleted
|
If true, the timecard was deleted by the merchant, and it is no longer valid. |
clockin_time
|
The clock-in time for the timecard, in ISO 8601 format. |
clockout_time
|
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
|
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
|
The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. |
created_at
|
The time when the timecard was created, in ISO 8601 format. |
updated_at
|
The time when the timecard was most recently updated, in ISO 8601 format. |
regular_seconds_worked
|
The total number of regular (non-overtime) seconds worked in the timecard. |
overtime_seconds_worked
|
The total number of overtime seconds worked in the timecard. |
doubletime_seconds_worked
|
The total number of doubletime seconds worked in the timecard. |
Response Fields
| Name | Description |
|---|---|
id
|
The timecard's unique ID. |
employee_id
Required
|
The ID of the employee the timecard is associated with. |
deleted
|
If true, the timecard was deleted by the merchant, and it is no longer valid. |
clockin_time
|
The clock-in time for the timecard, in ISO 8601 format. |
clockout_time
|
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
|
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
|
The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. |
created_at
|
The time when the timecard was created, in ISO 8601 format. |
updated_at
|
The time when the timecard was most recently updated, in ISO 8601 format. |
regular_seconds_worked
|
The total number of regular (non-overtime) seconds worked in the timecard. |
overtime_seconds_worked
|
The total number of overtime seconds worked in the timecard. |
doubletime_seconds_worked
|
The total number of doubletime seconds worked in the timecard. |
Examples
- cURL
curl https://connect.squareup.com/v1/me/timecards \
-X POST \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{}'