List Bank info
/unified/hris/bank_info
Query Parameters
Refer Specifying query parameters in Truto APIs
This represents employee
6 supported3 required6 notes
The employee (employees.id, the Omni user id) whose bank accounts to list. Required: Omni HR only exposes this per employee (the user id is part of the path). Exactly one employee: employee_id=, employee[id]=, [eq] or [in] with one id, or a one-element array. Several different ids, any other operator or a non-integer id is refused with a 400 (Omni HR has no multi-employee endpoint).
The employee (employees.id, Paychex workerId) whose direct deposit accounts to read. Required: Paychex stores direct deposits per worker.
The employee whose direct-deposit bank accounts to read (employees.id, the Paylocity Employee ID). Required: Paylocity stores bank accounts per employee and its response does not name the employee. Exactly one employee per request: one employee id in employee[id], employee_id or employee, as a plain value, [eq], or a one-element list ([] or [in]); several employees or another form are refused with a 400 before Paylocity is called.
Only these employees (employees.id, the HR WORKS person uuid). Sent as persons=&personIdentifierType=uuid. An id HR WORKS does not know returns an empty list. Several values are supported: repeat the parameter, separate them with commas, use the [] form, or the operator forms [eq] / [in]. Any other form (for example [ne] or a nested object) is refused with a 400 instead of being ignored, so a filter Truto cannot express never returns unfiltered data. HR WORKS keeps at most one bank account per person, inside the person's master data. Persons without a bank account (no bankAccount.iban) are not returned at all: a page can therefore hold fewer records than there are persons on it, or none, while next_cursor continues — keep paging until next_cursor is null. bank_info.get answers an empty object for a person without a bank account.
Filter by employee, referencing employees.id.
Only this employee's bank details (employees.id); one call to GET /core/v3/employees/{id}. Sesame has no bank-details endpoint, so one record is returned per employee — including employees with no account number stored, whose record then carries only id and employee. Several employees in one call are refused (400). Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.
6 supported6 notes
Flat alternative to employee.id (same values and forms).
Filter by the employee's unified id. Prefer the nested employee object form; this is a flat fallback.
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Also return persons who have left the company and were set to gone in HR WORKS (sent as onlyActive=false). By default only active persons are returned (onlyActive=true is sent); a person whose first working day is still in the future counts as active for HR WORKS and is returned by default (Truto reports them as employment_status pending). Deleted persons are never returned. Ignored when a person filter is given: HR WORKS then returns the requested person whatever their status. Accepts true/false in any letter case, also as [eq]; any other value or form (several values, [ne], a nested object) is refused with a 400 instead of being read as false. HR WORKS keeps at most one bank account per person, inside the person's master data. Persons without a bank account (no bankAccount.iban) are not returned at all: a page can therefore hold fewer records than there are persons on it, or none, while next_cursor continues — keep paging until next_cursor is null. bank_info.get answers an empty object for a person without a bank account.
1 supported
Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.
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 Bank info
The unique identifier for bank info
7 supported
This represents the account number
7 supported
This represents the account type
1 supported
This represents the bank name
3 supported
This represents the date when the bank info was created
1 supported
This represents employee
7 supported
Raw data returned from the remote API call.
This represents the date when the bank info was updated
1 supported
truto unified hris bankinfo \
-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',
'bankinfo',
{ 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",
"bankinfo",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/bank_info?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/bank_info?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/bank_info"
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())