Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Employee Tables

Create a new bank account entry for a given employee.

post/people/{id}/bank-accounts

Path parameters

idstring required

The ID of the employee for whom you want to add the bank account entry. The employee ID is returned in the 'id' field when retrieving an employee's data. <br /> For testing purposes you can obtain the Employee ID from the URL in the user interface.

Request body

bankAccountType'Checking' | 'Savings'

The list of bank accounts type comes with the above out-of-the-box values. To obtain additional user-defined values, you should fetch the list values call the <a href="https://apidocs.hibob.com/reference/get_company-named-lists-listname"> Get all company lists Metadata API</a> with bankaccounttype in the listname path parameter.

routingNumberstring

The routing number indicates what bank this account is held in. Relevant for US and Canada.

accountNicknamestring

The nickname in Bob to easily identify and personalize this account in Online Banking.

accountNumberstring

The account number is the unique identifier at this bank.

bankNamestring

The name of the specific financial institution.

branchAddressstring

The bank's address.

bicOrSwiftstring

The SWIFT Address assigned to the bank in order to send automated international transfers.

ibanstring

The international bank account number (IBAN) for international transfers.

allocation'percent' | 'amount' | 'remaining'

The salary portion allocated for this account. It can be defined as a percentage of the salary, as a fixed amount, or to allocate all of the remaining funds. The list of possible values cannot be modified. The values that correspond to this field should be provided in the 'amount' field.

amountnumber

Use this field to provide the values that correspond to the ‘allocation’ field. If allocation is 'percent' this value represents the percentage of the salary portion to allocate. If allocation is 'amount' this value represents the fixed amount of the salary portion to allocate. If allocation is 'remaining' then the amount field should remain empty. This indicates that all of the remaining funds will be allocated to this account.

useForBonusboolean

An indication whether this bank account is used for bonuses.

Response

Entry created successfully