List Timeoff balances
/unified/hris/timeoff_balances
Query Parameters
Refer Specifying query parameters in Truto APIs
This represents the employee the balance belongs to..
10 supported7 required7 notes
The employee, referencing employees.id (the Deel HRIS profile id). Required: Deel returns this data per employee.
The employee (employees.id, Paychex workerId) whose balances to list. Required: Paychex only returns balances per worker.
The employee (employees.id, a Remote employment id). Required: Remote only exposes this data per employment.
This represents the employee the balance belongs to.
The employee (employees.id, a Workday worker WID, or a reference such as Employee_ID=21001). Required: Workday only exposes this data per worker.
The employee to filter the time off balances by
Filter by employee, referencing employees.id.
The unique identifier for employees
6 supported1 required6 notes
The employee ID you want to get the time off balances for
Flat alternative to employee.id.
Filter by the employee's unified id. Prefer the nested employee object form; this is a flat fallback.
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id.
4 supported1 required4 notes
The date for which the time off balance is calculated
Deel tracking_period_date: return the balance of the tracking period containing this date (YYYY-MM-DD).
Calculate the balance as of this date (calendar date is used; time/offset is ignored). Defaults to today if omitted.
Return balances as of this date (YYYY-MM-DD; a date-time's time part is ignored). Defaults to today.
The time off policy ID you want to get the time off balances for
1 supported1 required
This represents the time off policy of the time off request.
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Timeoff balances
The unique identifier for time off balances
11 supported
This represents the balance of the time off request.
11 supported
This represents the date when the timeoffbalances was created
2 supported
This represents the employee the balance belongs to..
11 supported
2 properties
The unique identifier for employees
This represents the name of the employee.
Raw data returned from the remote API call.
This represents the time off policy of the time off request.
8 supported
This represents the date when the timeoffbalances was updated
2 supported
truto unified hris timeoffbalances \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'hris',
'timeoffbalances',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"hris",
"timeoffbalances",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/timeoff_balances?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/hris/timeoff_balances?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/timeoff_balances"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())