Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Time Punches

Update Time Punch

put/v2/company/{company_id}/time_punches/{time_punch_id}

Path parameters

company_idinteger required

Company id

time_punch_idinteger required

Time punch id

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

department_idinteger

Department ID

role_idinteger

The ID of the role that the user is clocking in to work for.

clocked_instring date-time

The start date and time when the user clocked in. Formatted as ISO8601 datetime in UTC timezone.

clocked_outstring date-time

The start date and time when the user clocked out. Formatted as ISO8601 datetime in UTC timezone.

notesstring

Additional notes for a shift.

tipsinteger nullable

Tips declared for the shift in cents

Example request

{
  "clocked_in": "2021-01-01T00:00:00.000Z",
  "clocked_out": "2021-01-01T00:00:00.000Z",
  "breaks": [
    {
      "id": 1234,
      "in": "2021-01-01T00:00:00.000Z",
      "out": "2021-01-01T00:00:00.000Z",
      "custom_break_id": 1234
    }
  ]
}

Response

OK

object'time_punch' required

Example response

{
  "data": {
    "clocked_in": "2020-01-20T12:00:00.000Z",
    "clocked_out": "2020-01-20T12:00:00.000Z",
    "pos_type": "web",
    "breaks": [
      {
        "in": "2020-01-20T12:00:00-0400",
        "out": "2020-01-20T12:00:00-0400"
      }
    ],
    "created": "2020-01-20T12:00:00.000Z",
    "modified": "2020-01-20T12:00:00.000Z"
  }
}