Employment HeroThis endpoint retrieves an employee's bank accounts. The response object is region-aware. Fields not applicable to the employee's payroll region will not be returned.
https:/api.employmenthero.com/api/v2/organisations/:organisation_id/employees/:employee_id/bank_accountsPath Parameters
The ID of the organisation to retrieve
The ID of the employee to retrieve
Query Parameters
Current page index
11Number of items per page
20100Response Body
A hash with a data property that contains an array of up to the limit of bank account records. Each entry in the array is a separate bank account object. If there is no more bank accounts, the resulting array will be empty.
The currency code for the bank account (e.g., "SGD").
The name of the bank account.
The type of bank account.
The account number of the bank account.
The BSB (Bank State Branch) number for Australian bank accounts.
The amount associated with the bank account.
Indicates whether this is the primary bank account.
The lock level for the bank account (e.g., employee).
External identifier for the bank account.
Text that appears on bank statements.
The roll number for the bank account.
The bank branch information.
The name of the bank.
The bank code.
The SWIFT/BIC code for the bank.
The address of the bank.
The name of the bank branch.
The branch code.
The institute number for the bank.
The payment method associated with the account.
The transit number for the bank account.
Current page index
11Number of items per page
20100Total items
Total pages
Example
curl -X GET \ "https://api.employmenthero.com/api/v2/organisations/:organisation_id/employees/:employee_id/bank_accounts" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "currency": "AUD", "account_name": "account_name", "account_type": "account_type", "account_number": "account_number", "bsb": "cbs", "amount": "1000", "primary_account": "primary_account", "lock_level": "employee", "external_id": "external_id", "statement_text": "statement text", "roll_number": "roll_number", "bank_branch": "bank_branch", "bank_name": "bank_name", "bank_code": "bank_code", "bank_swift_bic": "bank_swift_bic", "bank_address": "bank_address", "branch_name": "branch_name", "branch_code": "branch_code", "institute_number": "institute_number", "payment_method": "payment_method", "transit_number": "transit_number" } ], "page_index": 1, "item_per_page": 20, "total_items": 1, "total_pages": 1 }}