<- Labor API

Labor API

All versions ->

Create timecard

POST

 /v2/labor/timecards

Creates a new Timecard.

A Timecard represents a complete workday for a single team member. You must provide the following values in your request to this endpoint:

  • location_id
  • team_member_id
  • start_at

An attempt to create a new Timecard can result in a BAD_REQUEST error when:

  • The status of the new Timecard is OPEN and the team member has another timecard with an OPEN status.
  • The start_at date is in the future.
  • The start_at or end_at date overlaps another timecard for the same team member.
  • The Break instances are set in the request and a break start_at is before the Timecard.start_at, a break end_at is after the Timecard.end_at, or both.
Permissions:TIMECARDS_WRITE

Guide

Time Tracking with the Labor API

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique string value to ensure the idempotency of the operation.

Max Length
128
Link to section

timecard

Required

The Timecard to be created.

Link to section

Response fields

Link to section

timecard

The Timecard that was created on the request.

Link to section

errors

Any errors that occurred during the request.