Create completion

POST 
/api/v1/shifts/:shiftId/completions

Create a shift completion, creating a timecard for the shift.

Request

Path Parameters

shiftId stringrequired

Header Parameters

idempotency-key string

application/json

Body

required

data objectrequired
attributes objectrequired
externalFacilityId stringrequired
totalCost number
hourlyRate number
fees number
punches object[]required
Array [
type TimecardPunchActionrequired
Possible values: [START_BREAK, END_BREAK, SKIP_BREAK, CLOCK_IN, CLOCK_OUT, SUBMIT_SIGNATURE, START_SIGNATURE, AUTO_CLOCK_OUT]
punchTime date-timerequired
]
type stringrequired

Responses

200

application/json

Schema

Schema

data objectrequired
id stringrequired
type stringrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "string"
  }
}

4XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

5XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

Loading...