You are viewing an old version of the API

All Versions

Create 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

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.

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.

Permissions

TIMECARDS_WRITE

Deprecation date

2020-02-26

Retirement date

2021-02-26

Replaced by

CreateShift Migration guide

Request Body

Example code

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

curl https://connect.squareup.com/v1/me/timecards \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Labor API You are viewing an old version of the API 2020-08-26 Version 2020-08-26 All Versions Labor API Create 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.

Request Body

Response Fields

Examples

Share Feedback

You are viewing an old version of the API

All Versions

Create 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.