v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB

Employees

Time Off

Create Employee Time Off Request

post/unified/hris/employees/{id}/time_off

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

approver_idstring nullable

The approver ID

start_datestring datetime-local nullable

The start date of the time off request (ISO8601 date-time without timezone)

end_datestring datetime-local nullable

Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day

time_off_policy_idstring nullable

The time off policy id associated with this time off request

commentstring nullable

Allows users to provide additional context or notes for their time off request

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "approver_id": "1687-4",
  "start_date": "2021-01-01T01:01:01.000",
  "end_date": "2021-01-01T01:01:01.000",
  "time_off_policy_id": "cx280928933",
  "reason": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  },
  "comment": "Taking a day off for personal reasons",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

Record created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}