Get time off balances
Changed onRetrieve all time off balances.
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)
Request
- Base URLhttps://api.kombo.dev/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
The number of results to return per page. Maximum is 250.
Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. Returns records where either the record itself OR its nested data has been updated since this timestamp, even if the record's own changed_at field remains unchanged.
If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.
For more details, see Understanding changed_at vs updated_after Behavior.
For this endpoint, updated_after matches when the returned record changed, or when related data changed as described below.
| Path | Added/Removed | Linked Record |
|---|---|---|
| type | n/a | ✓ Yes |
Added/Removed: Whether adding or removing entries from this list triggers an update (n/a for single records). Linked Record: Whether changes to the linked record itself trigger an update.
By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.
When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
Filter by a comma-separated list of remote IDs.
Filter by a specific employee using their ID.
Headers
ID of the integration you want to interact with.
Response
GET /hris/time-off-balances Positive response
Example response
{
"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,
"custom_fields": {},
"integration_fields": [],
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null
}
}
]
}
}Changes
- info
added the required property
////to the response with the status - info
added the required property
////to the response with the status
- info
- breaking
the
//response's property type changed from no type toobjectfor status - info
added the new optional
queryrequest parameterignore_unsupported_filters - info
removed the pattern
/^([\da-z]{24}(,[\da-z]{24})*)?$/ifrom thequeryrequest parameterids - info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed
subschema #1subschema #2from the//response propertyallOflist for the response status - info
the
response property const valuesuccesswas added for the status - info
removed the
successenum value from theresponse property for the response status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status - info
added the required property
///to the response with the status
- breaking