POST
/
accounting
/
bank_accounts
Create Bank Account
curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/bank_accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 123,
  "data": [
    {
      "institution_name": "Example Bank",
      "account_name": "Savings Account",
      "account_number": "1234567890",
      "balance": 1000,
      "currency_id": "USD",
      "updated_at": "2024-01-25T10:30:00Z"
    }
  ]
}'
{
  "data": {
    "rootfi_id": 123,
    "rootfi_deleted_at": null,
    "rootfi_created_at": "2024-01-25T09:00:00Z",
    "rootfi_updated_at": "2024-01-25T09:30:00Z",
    "rootfi_company_id": 456,
    "platform_id": "123456_1",
    "platform_unique_id": "123456",
    "institution_name": "Example Bank",
    "account_name": "Savings Account",
    "account_number": "1234567890",
    "balance": 1000,
    "currency_id": "USD",
    "updated_at": "2024-01-25T10:30:00Z"
  }
}
The Bank Accounts Data Model streamlines access of bank account information across various accounting platforms, providing a consistent and unified representation of bank account data.

​
Additional Required Fields

To successfully create a bank account, certain fields must be included in the raw_data object of the request body. The required fields are as follows:
IntegrationFieldDescription
MYOB_BUSINESSnominal_codeThe nominal code of the bank account.
MYOB_BUSINESSdescriptionThe description of the bank account.
MYOB_BUSINESSparent_account_idThe parent account ID of the bank account.
MYOB_BUSINESStax_idThe tax ID of the bank account.
SAGE_ZA_CLOUD_ACCOUNTINGsub_category_idThe sub-category ID associated to the account.

Authorizations

​
api_key
string
header
required

Body

application/json
​
data
accountingBankAccountFields · object[]
required

The data of the bank account to create

​
company_id
integer
required

The ID of the company in the accounting platform

​
run_async
boolean | null

Run the request asynchronously

Response

​
data
object

The data of the created bank account

​
sync_id
string | null

The sync id of the request