Skip to content
GET /unified/hris/bank_info/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

employeeobject

This represents employee

References: Employees → id
3 supported3 required3 notes
Omni HR
required

The employee (employees.id, the Omni user id) whose bank account to read. 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).

Paychex
required

The employee (employees.id, Paychex workerId) whose direct deposit accounts to read. Required: Paychex stores direct deposits per worker.

Paylocity
required

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.

idstring
required
employee_idstring
3 supported3 notes
Omni HR
supported

Flat alternative to employee.id (same forms).

Paychex
supported

Flat alternative to employee.id.

Paylocity
supported

Flat alternative to employee.id (same forms).

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

idstring
required·

The unique identifier for bank info

7 supported
HR WORKS
supported
Humaans
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Sesame
supported
account_numberstring

This represents the account number

7 supported
HR WORKS
supported
Humaans
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Sesame
supported
account_typestring

This represents the account type

1 supported
Paychex
supported
bank_namestring

This represents the bank name

3 supported
Humaans
supported
Omni HR
supported
Paylocity
supported
created_atstring · date-time

This represents the date when the bank info was created

1 supported
Humaans
supported
employeestring

This represents employee

References: Employees → id
7 supported
HR WORKS
supported
Humaans
supported
Omni HR
supported
Paychex
supported
PayFit
supported
Paylocity
supported
Sesame
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

This represents the date when the bank info was updated

1 supported
Humaans
supported
truto unified hris bankinfo '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'hris',
  'bankinfo',
  '<resource_id>',
  { 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():
    result = await truto_api.unified_api.get(
        "hris",
        "bankinfo",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/hris/bank_info/{id}?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/{id}?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/{id}"
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())