Skip to main content
POST
/
api
/
hris
/
v1
/
time-off
Create 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",
  "amount": 12,
  "request_type": "VACATION",
  "start_time": "2023-04-10T00:00:00Z",
  "approver": "018b4bfb-6065-7f83-b11d-e85ea49e37c3",
  "status": "APPROVED",
  "employee_note": "Paid paid vacation! Scuba diving in Hawaii.",
  "units": "HOURS",
  "end_time": "2023-04-10T00:00:00Z"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
This endpoint creates a Timeoff Entry in the connected HRIS via Bindbee’s unified Time Off model.

​
Provider-specific behavior

Different HRIS systems can have slightly different requirements and behaviors when creating timeoff entries. Use the accordions below to see details for each provider.

When the underlying HRIS is ADP, a Timesheet Entry can be created using a payload like:

{
    "employee": "01929f6e-c6c1-74b4-8119-a7d9efc0c8b8",
    "amount": 8,
    "start_time": "2024-09-04T08:00:00Z",
    "end_time": "2024-09-04T16:00:00Z",
    "request_type": "VACATION"
}

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<uuid> | 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
enum<string>
required

The type of time off request. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
VACATION,
SICK,
PERSONAL,
JURY_DUTY,
VOLUNTEER,
BEREAVEMENT,
MATERNITY,
ANNUAL_LEAVE,
EMERGENCY_LEAVE,
LEAVE_OF_ABSENCE,
PATERNITY,
PAID_TIME_OFF,
LONG_TERM_DISABILITY,
SHORT_TERM_DISABILITY,
COMP_OFF,
WORK_FROM_HOME,
COMPASSIONATE,
TIME_OFF,
FMLA
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<uuid> | null

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

Example:

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

​
status
enum<string>
default:""

The status of this time off request. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
REQUESTED,
APPROVED,
DECLINED,
CANCELLED,
DELETED
Example:

"APPROVED"

​
employee_note
string | null
default:""

The employee note for this time off request.

Example:

"Paid paid vacation! Scuba diving in Hawaii."

​
units
enum<string>
default:""

The measurement that the third-party integration uses to count time requested. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
HOURS,
DAYS
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

Successful Response