Skip to content

Update Bank info

PATCH /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

The employee (employees.id, the Omni user id) whose bank account to change (Omni PATCH: only the fields sent change). Changes where the employee's pay is deposited (Omni bank information, used by Omni payroll). Omni documents edit approval for the Bank Information section; whether an API write becomes a pending request instead of a change is undocumented.. 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).

References: Employees → id
1 supported1 required
Omni HR
required
idstring
required
employee_idstring

Flat alternative to employee.id (same forms).

1 supported
Omni HR
supported
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_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

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

Request Body

Refer Writing data using Unified APIs

account_numberstring

The new account number. Changes where the employee's pay is deposited (Omni bank information, used by Omni payroll). Omni documents edit approval for the Bank Information section; whether an API write becomes a pending request instead of a change is undocumented. An error after the update may mean the change was saved: Omni HR applies it first, then the record is read back, and that read can fail (for example when rate-limited). Check with bank_info get; repeating the same update is safe.

1 supported
Omni HR
supported
bank_namestring

The bank's name.

1 supported
Omni HR
supported
remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

idstring
required·

The unique identifier for bank info

1 supported
Omni HR
supported
account_numberstring

This represents the account number

1 supported
Omni HR
supported
account_typestring

This represents the account type

bank_namestring

This represents the bank name

1 supported
Omni HR
supported
created_atstring · date-time

This represents the date when the bank info was created

employeestring

This represents employee

References: Employees → id
1 supported
Omni HR
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

truto unified hris bankinfo '<resource_id>' \
  -m update \
  -a '<integrated_account_id>' \
  -b '{
  "account_number": "your_account_number",
  "bank_name": "your_bank_name",
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.update(
  'hris',
  'bankinfo',
  '<resource_id>',
  {
  "account_number": "your_account_number",
  "bank_name": "your_bank_name",
  "remote_data": {}
},
  { 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.update(
        "hris",
        "bankinfo",
        "<resource_id>",
        {
        "account_number": "your_account_number",
        "bank_name": "your_bank_name",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X PATCH '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' \
  -d '{
  "account_number": "your_account_number",
  "bank_name": "your_bank_name",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "account_number": "your_account_number",
  "bank_name": "your_bank_name",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/hris/bank_info/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

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>"
}
payload = {
    "account_number": "your_account_number",
    "bank_name": "your_bank_name",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())