Skip to main content
POST
/
unified
/
hris
/
employees
/
{id}
/
time_off
Create Employee Time Off Request
curl --request POST \
  --url https://api.stackone.com/unified/hris/employees/{id}/time_off \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "approver_id": "1687-4",
  "status": {
    "value": "approved",
    "source_value": "<string>"
  },
  "type": {
    "value": "sick",
    "source_value": "<string>"
  },
  "start_date": "2021-01-01T01:01:01.000",
  "end_date": "2021-01-01T01:01:01.000",
  "start_half_day": true,
  "end_half_day": true,
  "time_off_policy_id": "cx280928933",
  "reason": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "<string>"
  },
  "comment": "Taking a day off for personal reasons",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Body

application/json
​
approver_id
string | null

The approver ID

Example:

"1687-4"

​
status
object

The status of the time off request

​
type
object
deprecated

The type of the time off request

​
start_date
string<datetime-local> | null

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

Example:

"2021-01-01T01:01:01.000"

​
end_date
string<datetime-local> | null

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

Example:

"2021-01-01T01:01:01.000"

​
start_half_day

True if the start of the time off request begins half way through the day

Example:

true

​
end_half_day

True if the end of the time off request ends half way through the day

Example:

true

​
time_off_policy_id
string | null

The time off policy id associated with this time off request

Example:

"cx280928933"

​
reason
object
​
comment
string | null

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

Example:

"Taking a day off for personal reasons"

​
passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

Record created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required