Create Bank Transaction

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
- Bank Transactions
  - Overview
  - Overview
  - GET
    Get All Bank Transactions
  - POST
    Create Bank Transaction
- 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

POST

accounting

bank_transactions

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/bank_transactions \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 123,
  "data": [
    {
      "contact_id": "123456",
      "account_id": "123456",
      "from_account_id": "123456",
      "to_account_id": "123456",
      "currency_id": "123456",
      "amount": 1000,
      "type": "creditcard",
      "debit_or_credit": "DEBIT",
      "status": "Test",
      "currency_rate": 1000,
      "transaction_date": "2024-01-25T09:00:00Z",
      "updated_at": "2024-01-25T09:00: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",
    "contact_id": "123456",
    "account_id": "123456",
    "from_account_id": "123456",
    "to_account_id": "123456",
    "currency_id": "123456",
    "amount": 1000,
    "type": "creditcard",
    "debit_or_credit": "DEBIT",
    "status": "Test",
    "currency_rate": 1000,
    "transaction_date": "2024-01-25T09:00:00Z",
    "updated_at": "2024-01-25T09:00:00Z"
  }
}

Bank Transactions include the Transactional banking data for a specific company and account.

Additional Required Fields

To successfully create an bank transaction, certain fields must be included in the raw_data object of the request body. The required fields are as follows:

Integration	Field	Description
ZOHO_BOOKS	from_account_id	The ID of the account from which the amount is transferred.
XERO	from_account_id	The ID of the account from which the amount is transferred.
FRESH_BOOKS	reference	The reference for the transaction.
MYOB_BUSINESS	tax_id	The ID of the tax applied to the transaction.
SAGE_CLOUD_ACCOUNTING	reference	The reference for the transaction.

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

object[]

required

The data of the bank account to create

run_async

boolean | null

Run the request asynchronously

Response

200

application/json

data

object

The data of the created bank account

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.contact_id

string | null

The contact id of the bank account

data.account_id

string | null

The account id of the bank account

data.from_account_id

string | null

The from account id of the bank account

data.to_account_id

string | null

The to account id of the bank account

data.currency_id

string | null

The currency id of the bank account

data.amount

integer | null

The amount of the bank account

data.type

string | null

The type of the bank account

data.debit_or_credit

string | null

The debit or credit of the bank account

data.status

string | null

The status of the bank account

data.currency_rate

integer | null

The currency rate of the bank account

data.transaction_date

string | null

The transaction date of the bank account

data.updated_at

string | null

The updated at of the bank account

data.account

object

The account of the bank transaction.

data.account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.account.platform_id

string

required

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

Example:

"123456"

data.account.rootfi_deleted_at

string | null

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

data.account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.account.raw_data

object | null

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

data.account.data_hash

string | null

The hash of the data

data.account.name

string | null

Name of the account

data.account.description

string | null

Description of the account

data.account.nominal_code

string | null

The nominal code of the account

data.account.current_balance

number | null

The current balance of the account

data.account.updated_at

string | null

The date the account was last updated

data.account.status

string | null

The status of the account

data.account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.account.sub_category

string | null

The sub category of the account

data.account.currency_id

string | null

The currency id of the account

data.account.parent_account_id

string | null

The parent account id of the account

data.account.parent_account

object

The parent account of the account.

data.account.parent_account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.account.parent_account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.account.parent_account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.account.parent_account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.account.parent_account.platform_id

string

required

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

Example:

"123456"

data.account.parent_account.rootfi_deleted_at

string | null

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

data.account.parent_account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.account.parent_account.raw_data

object | null

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

data.account.parent_account.data_hash

string | null

The hash of the data

data.account.parent_account.name

string | null

Name of the account

data.account.parent_account.description

string | null

Description of the account

data.account.parent_account.nominal_code

string | null

The nominal code of the account

data.account.parent_account.current_balance

number | null

The current balance of the account

data.account.parent_account.updated_at

string | null

The date the account was last updated

data.account.parent_account.status

string | null

The status of the account

data.account.parent_account.category

enum<string>

The category of the account

Available options:

ASSET,

EXPENSE,

LIABILITY,

EQUITY,

INCOME,

BANK,

UNKNOWN

data.account.parent_account.sub_category

string | null

The sub category of the account

data.account.parent_account.currency_id

string | null

The currency id of the account

data.account.parent_account.parent_account_id

string | null

The parent account id of the account

data.account.currency

object

The currency of the account.

data.from_account

object

The from account of the bank transaction.

data.from_account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.from_account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.from_account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.from_account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.from_account.platform_id

string

required

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

Example:

"123456"

data.from_account.rootfi_deleted_at

string | null

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

data.from_account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.from_account.raw_data

object | null

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

data.from_account.data_hash

string | null

The hash of the data

data.from_account.institution_name

string | null

The name of the bank account

data.from_account.account_name

string | null

Name of the bank account

data.from_account.account_number

string | null

The bank account number

data.from_account.balance

number | null

Balance of the bank account

data.from_account.currency_id

string | null

The currency id of the bank account

data.from_account.category

string | null

The category of the bank account

data.from_account.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.from_account.currency

object

The currency of the bank account.

data.to_account

object

The to account of the bank transaction.

data.to_account.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.to_account.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.to_account.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.to_account.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.to_account.platform_id

string

required

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

Example:

"123456"

data.to_account.rootfi_deleted_at

string | null

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

data.to_account.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.to_account.raw_data

object | null

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

data.to_account.data_hash

string | null

The hash of the data

data.to_account.institution_name

string | null

The name of the bank account

data.to_account.account_name

string | null

Name of the bank account

data.to_account.account_number

string | null

The bank account number

data.to_account.balance

number | null

Balance of the bank account

data.to_account.currency_id

string | null

The currency id of the bank account

data.to_account.category

string | null

The category of the bank account

data.to_account.updated_at

string | null

The last ISO 8601 timestamp that the data was updated at

data.to_account.currency

object

The currency of the bank account.

data.contact

object

The contact of the bank transaction.

data.contact.rootfi_id

number

required

The unique ID we assign for that data's information

Example:

157

data.contact.rootfi_created_at

string

required

The date at which RootFi first synced this data

Example:

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

data.contact.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

Example:

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

data.contact.rootfi_company_id

number

required

The ID of the company in the accounting platform

Example:

1089

data.contact.platform_id

string

required

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

Example:

"123456"

data.contact.rootfi_deleted_at

string | null

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

data.contact.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.contact.raw_data

object | null

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

data.contact.data_hash

string | null

The hash of the data

data.contact.name

string | null

Name of the contact

data.contact.contact_name

string | null

Name of the contact person for the contact

data.contact.contact_type

enum<string>

The type of contact. Values are either CUSTOMER or VENDOR

Available options:

CUSTOMER,

VENDOR

data.contact.currency_id

string | null

The ISO-4217 currency code

data.contact.tax_number

string | null

Contact’s tax number

data.contact.registration_number

string | null

Contact’s identifying number

data.contact.status

enum<string>

The status of the contact. Values are ACTIVE, ARCHIVED, UNKNOWN

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.contact.updated_at

string | null

The date the contact was last updated

data.contact.external_links

object[] | null

External links for the contact

data.contact.phone_numbers

object[] | null

Phone numbers for the contact

data.contact.addresses

object[] | null

Addresses for the contact

data.currency

object

The currency of the account.

sync_id

string | null

The sync id of the request

Get All Bank Transactions Overview

curl --request POST \
  --url https://api.rootfi.dev/v3/accounting/bank_transactions \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_id": 123,
  "data": [
    {
      "contact_id": "123456",
      "account_id": "123456",
      "from_account_id": "123456",
      "to_account_id": "123456",
      "currency_id": "123456",
      "amount": 1000,
      "type": "creditcard",
      "debit_or_credit": "DEBIT",
      "status": "Test",
      "currency_rate": 1000,
      "transaction_date": "2024-01-25T09:00:00Z",
      "updated_at": "2024-01-25T09:00: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",
    "contact_id": "123456",
    "account_id": "123456",
    "from_account_id": "123456",
    "to_account_id": "123456",
    "currency_id": "123456",
    "amount": 1000,
    "type": "creditcard",
    "debit_or_credit": "DEBIT",
    "status": "Test",
    "currency_rate": 1000,
    "transaction_date": "2024-01-25T09:00:00Z",
    "updated_at": "2024-01-25T09:00:00Z"
  }
}

General

Server Side SDKs

Core API

Unified API

​Additional Required Fields

Authorizations

Body

Response

Additional Required Fields