Get All Bank Accounts

Integrations Roadmap

Data Coverage Tool

General

Overview

Server Side SDKs

Typescript SDK

Core API

Companies
Invite Links
Sync
Passthrough
Real Time
Webhooks

Unified API

Accounting
- Accounts
- Bank Accounts
  - Overview
  - Overview
  - GET
    Get All Bank Accounts
  - POST
    Get All Bank Accounts
  - POST
    Create Bank Account
  - POST
    Create Bank Account
- Bank Transactions
- Bills
- Bill Payments
- Bill Credit Notes
- Contacts
- Company Info
- Currencies
- Documents
- Expenses
- Invoice Credit Notes
- Invoices
- Invoice Payments
- Items
- Journal Entries
- Purchase Orders
- Sales Orders
- Goods Receipt Notes
- Projects
- Tax Rates
- Tracking Categories
- Balance Sheet
- Cash Flow Statements
- Income Statements
Payments
Ecommerce
CRM

GET

accounting

bank_accounts

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/bank_accounts \
  --header 'api_key: <api-key>'

{
  "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"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

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.

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

string | null

The next page of objects to retrieve

string | null

The previous page of objects to retrieve

expand

string | null

Comma separated fields to expand. Supported values are currency

select

string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_updated_at[gte]

string | null

Filter by rootfi_updated_at Greater than or Equal To.

rootfi_company_id[eq]

integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

include_deleted_records

string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

return_count

string | null

Return the count of the objects. Supported values are true and false

sort[rootfi_created_at]

enum<string>

Sort by rootfi_created_at

Available options:

ASC,

DESC

sort[rootfi_updated_at]

enum<string>

Sort by rootfi_updated_at

Available options:

ASC,

DESC

Response

200

application/json

The data of the bank accounts endpoint

data

object[]

required

data.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.rootfi_deleted_at

string | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object | null

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.institution_name

string | null

The name of the bank account

data.account_name

string | null

Name of the bank account

data.account_number

string | null

The bank account number

data.balance

number | null

Balance of the bank account

data.currency_id

string | null

The currency id of the bank account

data.category

string | null

The category of the bank account

data.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.currency

object

The currency of the bank account.

string | null

The previous page of objects to retrieve

string | null

The next page of objects to retrieve

total_count

integer | null

The total count of the objects

Overview Get All Bank Accounts

curl --request GET \
  --url https://api.rootfi.dev/v3/accounting/bank_accounts \
  --header 'api_key: <api-key>'

{
  "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"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}