POST
/
api
/
hris
/
v1
/
time-off
curl --request POST \
  --url https://api.bindbee.dev/api/hris/v1/time-off \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '{
  "employee": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "approver": "018b4bfb-6065-7f83-b11d-e85ea49e37c3",
  "status": "APPROVED",
  "employee_note": "Paid paid vacation! Scuba diving in Hawaii.",
  "units": "HOURS",
  "amount": 12,
  "request_type": "VACATION",
  "start_time": "2023-04-10T00:00:00Z",
  "end_time": "2023-04-10T00:00:00Z"
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Body

application/json

The TimeOff object is used to represent all employees' Time Off entries.

​
employee
string | null
required

The employee requesting time off.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
amount
required

The time off quantity measured by the prescribed “units”.

Example:

12

​
request_type
string | null
required

The type of time off request.

Example:

"VACATION"

​
start_time
string | null
required

The day and time of the start of the time requested off.

Example:

"2023-04-10T00:00:00Z"

​
approver
string | null
default:

The Bindbee ID of the employee with the ability to approve the time off request.

Example:

"018b4bfb-6065-7f83-b11d-e85ea49e37c3"

​
status
string | null
default:

The status of this time off request.

Example:

"APPROVED"

​
employee_note
string | null
default:

The employee note for this time off request.

Example:

"Paid paid vacation! Scuba diving in Hawaii."

​
units
string | null
default:

The measurement that the third-party integration uses to count time requested.

Example:

"HOURS"

​
end_time
string | null
default:The day and time of the end of the time requested off.
Example:

"2023-04-10T00:00:00Z"

Response

201
application/json
Successful Response

The response is of type any.