Create absence

POST

hris

absences

curl --request POST \
  --url https://api.kombo.dev/v1/hris/absences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "employee_id": "wXJMxwDvPAjrJ4CyqdV9",
  "absence_type_id": "3YKtQ7qedsrcCady1jSyAkY1",
  "start_date": "2019-09-17",
  "end_date": "2019-09-21",
  "start_time": "08:30:00",
  "end_time": "16:00:00",
  "start_half_day": false,
  "end_half_day": false,
  "employee_note": "Visiting the aliens"
}'

{
  "status": "success",
  "data": {
    "id": "22st2Ji8XpncEYEak8mvQgQF",
    "remote_id": "1348",
    "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
    "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
    "start_date": "2022-08-04",
    "end_date": "2022-08-05",
    "start_half_day": true,
    "end_half_day": false,
    "start_time": "13:15:00",
    "end_time": "17:00:00",
    "amount": 2,
    "unit": "DAYS",
    "status": "APPROVED",
    "employee_note": "Visiting my family.",
    "type_id": "xzZoKssDaMZAd62kxayzzQvD",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_deleted_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null
  }
}

Supported integrations

Check this page for a detailed guide.

This endpoint requires the permission Manage absences to be enabled in your scope config.

Example Request Body

{
  "employee_id": "wXJMxwDvPAjrJ4CyqdV9",
  "absence_type_id": "3YKtQ7qedsrcCady1jSyAkY1",
  "start_date": "2019-09-17",
  "end_date": "2019-09-21",
  "start_time": "08:30:00",
  "end_time": "16:00:00",
  "start_half_day": false,
  "end_half_day": false,
  "employee_note": "Visiting the aliens"
}

Authorizations

Authorization

string

header

required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

X-Integration-Id

string

required

ID of the integration you want to interact with.

Body

application/json

POST /hris/absences request body

employee_id

string

required

The ID of the employee in Kombo or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)

absence_type_id

string

required

The ID of the absence type in Kombo (not its remote_id).

start_date

string

required

The date that the absence starts. This is a plain date (i.e., yyyy-MM-dd), with all time information discarded.

end_date

string

required

When the absence ends.The date that the absence ends. This is a plain date (i.e., yyyy-MM-dd), with all time information discarded.

employee_note

string | null

required

A note describing the reason for this absence.

status

enum<string>

default:REQUESTED

The state that the absence should be created in. Some tools may approve absences automatically if they were created for an absence type that does not require approval.

Available options:

REQUESTED,

APPROVED

start_half_day

boolean

default:false

true if the absence should start in the middle of the day.

end_half_day

boolean

default:false

true if the absence should end in the middle of the day.

amount

number

The amount of time of the absence. Specifying this also requires specifying unit. This is supported by very few tools.

Required range: x >= 0

unit

enum<string>

The time unit of the amount value. Specifying this also requires specifying amount.

Available options:

HOURS,

DAYS

start_time

string

The time of when the absence begins. Follows the format HH:mm or HH:mm:ss (e.g., 14:45:15). If start_time is specified, end_time has to be specified as well.

end_time

string

The time of when the absence ends. Follows the format HH:mm or HH:mm:ss (e.g., 14:45:15). If end_time is specified, start_time has to be specified as well.

remote_fields

object

Additional fields that we will pass through to specific HRIS systems.

Response

200

application/json

POST /hris/absences Successful response

status

enum<string>

required

Available options:

success

data

object

required

data.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.remote_id

string | null

required

The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.

data.employee_id

string

required

The Kombo ID of the employee to which the absence belongs to. The ID can be used to retrieve the employee from the get employees endpoint.

data.approver_id

string | null

required

deprecated

(⚠️ Deprecated - We won't increase coverage for this feature) The Kombo ID of the employee who is responsible for approving this absence.

data.start_date

string | null

required

The date this absence starts in the yyyy-MM-dd format.

data.end_date

string | null

required

The date this absence ends in the yyyy-MM-dd format.

data.start_half_day

boolean | null

required

true if the absence starts in the middle of the day, false if not, and null if the absence type doesn't support half-day absences. For multi-day absences, this only applies to the first day of the absence.

data.end_half_day

boolean | null

required

true if the absence ends in the middle of the day, false if not, and null if the absence type doesn't support half-day absences. For multi-day absences, this only applies to the last day of the absence.

data.start_time

string | null

required

The time at which this absence starts. Follows the format HH:mm:ss (e.g., 14:45:15).

data.end_time

string | null

required

The time at which this absence ends. Follows the format HH:mm:ss (e.g., 14:45:15).

data.amount

number | null

required

The amount of time this absence takes.

data.unit

enum<string> | null

required

The unit of time for this absence. Can be HOURS or DAYS.

Available options:

HOURS,

DAYS

data.status

required

The absence’s current status. In rare cases where we can’t find a clear mapping, the original string is passed through.

Available options:

REQUESTED,

APPROVED,

DECLINED,

CANCELLED,

DELETED

data.employee_note

string | null

required

A note the employee has added to this absence.

data.type_id

string | null

required

The Kombo absence type ID of this absence.

data.changed_at

string

required

The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.

data.remote_deleted_at

string | null

required

The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.

data.remote_data

object | null

required

Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.

Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: { "/companies": { ... }}

This is not available on all plans. Reach out to Kombo if you need it.

Example:

{
  "id": "22st2Ji8XpncEYEak8mvQgQF",
  "remote_id": "1348",
  "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
  "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
  "start_date": "2022-08-04",
  "end_date": "2022-08-05",
  "start_half_day": true,
  "end_half_day": false,
  "start_time": "13:15:00",
  "end_time": "17:00:00",
  "amount": 2,
  "unit": "DAYS",
  "status": "APPROVED",
  "employee_note": "Visiting my family.",
  "type_id": "xzZoKssDaMZAd62kxayzzQvD",
  "changed_at": "2022-08-07T14:01:29.196Z",
  "remote_deleted_at": "2022-08-07T14:01:29.196Z",
  "remote_data": null
}

Get time off balances Delete absence

curl --request POST \
  --url https://api.kombo.dev/v1/hris/absences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "employee_id": "wXJMxwDvPAjrJ4CyqdV9",
  "absence_type_id": "3YKtQ7qedsrcCady1jSyAkY1",
  "start_date": "2019-09-17",
  "end_date": "2019-09-21",
  "start_time": "08:30:00",
  "end_time": "16:00:00",
  "start_half_day": false,
  "end_half_day": false,
  "employee_note": "Visiting the aliens"
}'

{
  "status": "success",
  "data": {
    "id": "22st2Ji8XpncEYEak8mvQgQF",
    "remote_id": "1348",
    "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
    "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
    "start_date": "2022-08-04",
    "end_date": "2022-08-05",
    "start_half_day": true,
    "end_half_day": false,
    "start_time": "13:15:00",
    "end_time": "17:00:00",
    "amount": 2,
    "unit": "DAYS",
    "status": "APPROVED",
    "employee_note": "Visiting my family.",
    "type_id": "xzZoKssDaMZAd62kxayzzQvD",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_deleted_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null
  }
}

General

Features

Guides

HRIS API Reference

General API Reference

DATEV

Create absence

Example Request Body

Authorizations

Headers

Body

Response

General

Features

Guides

HRIS API Reference

General API Reference

DATEV

​Example Request Body

Authorizations

Headers

Body

Response

Example Request Body