Get time off balances

General

Introduction
Getting started
Implementation guide
FAQ

Features

Guides

HRIS API Reference

Employees
Organization
Employee Documents
Time off
Time and attendance

General API Reference

Kombo Connect
Integrations
Filtering
Custom Fields
Other

DATEV

Getting Started
DATEV Payroll
DATEV Documents ( Payslips )
DATEV eAU
DATEV ( legacy )

GET

hris

time-off-balances

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "FuyRuk5NqP3qTcThED3ymTuE",
        "remote_id": "124123",
        "employee_id": "2Up4ZCvq1bFVzmzXG6EWzV3j",
        "type_id": "BQJaBxRCiqN46G27VTegvkEr",
        "balance": 14,
        "balance_unit": "DAYS",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "used": 3,
        "used_unit": "DAYS",
        "remote_data": null,
        "type": {
          "id": "xzZoKssDaMZAd62kxayzzQvD",
          "remote_id": "91",
          "name": "Vacation",
          "unit": "DAYS",
          "half_days_supported": true,
          "exact_times_supported": false,
          "remote_data": null,
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_deleted_at": null
        }
      }
    ]
  }
}

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

Authorizations

Authorization

string

headerrequired

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.

Query Parameters

cursor

string

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_size

integer

default: 100

The number of results to return per page. Maximum is 250.

Required range: 1 < x < 250

updated_after

string

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

include_deleted

enum<string>

default: false

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

Available options:

true,

false

ids

string

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3. Those IDs are validated to be 24 characters long and to exist for this integration in the database. If any of the IDs don't exist, the endpoint will return a 404 error.

remote_ids

string

Filter by a comma-separated list of remote IDs.

employee_id

string

Filter by a specific employee using their ID.

Response

200 - application/json

status

enum<string>

required

Available options:

success

data

object

required

data.next

string | null

required

Cursor string that can be passed to the cursor query parameter to get the next page. If this is null, then there are no more pages.

data.results

object[]

required

data.results.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.results.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.results.employee_id

string

required

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

data.results.type_id

string

required

data.results.balance

number | null

required

The amount of time available to the employee.

data.results.balance_unit

enum<string> | null

required

The time-unit of the balance.

Available options:

HOURS,

DAYS

data.results.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.results.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.results.used

number | null

required

The amount of time used by the employee.

data.results.used_unit

enum<string> | null

required

The time-unit of the used time.

Available options:

HOURS,

DAYS

data.results.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.

data.results.type

object

required

Get absence types Create absence

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "FuyRuk5NqP3qTcThED3ymTuE",
        "remote_id": "124123",
        "employee_id": "2Up4ZCvq1bFVzmzXG6EWzV3j",
        "type_id": "BQJaBxRCiqN46G27VTegvkEr",
        "balance": 14,
        "balance_unit": "DAYS",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "used": 3,
        "used_unit": "DAYS",
        "remote_data": null,
        "type": {
          "id": "xzZoKssDaMZAd62kxayzzQvD",
          "remote_id": "91",
          "name": "Vacation",
          "unit": "DAYS",
          "half_days_supported": true,
          "exact_times_supported": false,
          "remote_data": null,
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_deleted_at": null
        }
      }
    ]
  }
}