Create Bank Account

Create a new bank account.

POST /accounting/bank_accounts

Create Bank Account

cURL

curl --request POST \
  --url https://api.rootfi.dev/accounting/bank_accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1,
  "data": [
    {
      "institution_name": "Bank Central Asia",
      "account_name": "Rootfi Test",
      "category": "DEPOSIT",
      "account_number": "1234567890",
      "balance": 1000000,
      "currency_id": "IDR"
    }
  ]
}
'

200

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "aXI9pUDA5T7E2LS",
    "data": [
      {
        "job_id": "xQm2K441VosP8W4",
        "status": "success",
        "response": {
          "platform_id": "4009750000000000099",
          "currency_id": "4009750000000000099",
          "institution_name": "rootfi 63503",
          "account_name": "test 22300",
          "category": "credit_card",
          "balance": 123456,
          "updated_at": "2021-09-28T15:00:00.000Z",
          "raw_data": {
            "nominal_code": "Rootfi 01",
            "name": "Test Account",
            "description": "Test Description",
            "category": "LIABILITY",
            "sub_category": "Long Term Liabilities",
            "status": null
          }
        },
        "error": null
      }
    ]
  },
  "request_timestamp": "2021-09-28T15:00:00.000Z",
  "response_timestamp": "2021-09-28T15:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

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:

Integration	Field	Description
MYOB_BUSINESS	nominal_code	The nominal code of the bank account.
MYOB_BUSINESS	description	The description of the bank account.
MYOB_BUSINESS	parent_account_id	The parent account ID of the bank account.
MYOB_BUSINESS	tax_id	The tax ID of the bank account.
SAGE_ZA_CLOUD_ACCOUNTING	sub_category_id	The sub-category ID associated to the account.

Authorizations

api_key · string · header · required

Body

application/json

company_id · integer · required

The company ID

Example:

1

data · accountingtypesBankAccountsWriteRequestFields · object[] · required

The data to be passed through to the integration platform

Show child attributes

Response

200 - application/json

data · accountingtypesCreateBankAccountsResponseDataHelper · object · required

Show child attributes

request_timestamp · string<date-time> · required

The time at which the request was received by the server

response_timestamp · string<date-time> · required

The time at which the response was sent by the server

request_id · string · required

The unique ID of the request