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"
    }
  ]
}
'

import requests

url = "https://api.rootfi.dev/v3/accounting/bank_accounts"

payload = {
    "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"
        }
    ]
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
      }
    ]
  })
};

fetch('https://api.rootfi.dev/v3/accounting/bank_accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootfi.dev/v3/accounting/bank_accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootfi.dev/v3/accounting/bank_accounts"

	payload := strings.NewReader("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rootfi.dev/v3/accounting/bank_accounts")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/accounting/bank_accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

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"
    }
  ]
}
'

import requests

url = "https://api.rootfi.dev/v3/accounting/bank_accounts"

payload = {
    "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"
        }
    ]
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
      }
    ]
  })
};

fetch('https://api.rootfi.dev/v3/accounting/bank_accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootfi.dev/v3/accounting/bank_accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootfi.dev/v3/accounting/bank_accounts"

	payload := strings.NewReader("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rootfi.dev/v3/accounting/bank_accounts")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/accounting/bank_accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 123,\n  \"data\": [\n    {\n      \"institution_name\": \"Example Bank\",\n      \"account_name\": \"Savings Account\",\n      \"account_number\": \"1234567890\",\n      \"balance\": 1000,\n      \"currency_id\": \"USD\",\n      \"updated_at\": \"2024-01-25T10:30:00Z\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

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 ID of the company in the accounting platform

data

accountingBankAccountFields · object[]

required

The data of the bank account to create

Show child attributes

run_async

boolean | null

Run the request asynchronously

Response

data

accountingBankAccountObject · object | null

The data of the created bank account

Show child attributes

sync_id

string | null

The sync id of the request

Get All Bank Accounts

Overview

General

Server Side SDKs

Core API

Unified API

Create Bank Account

Additional Required Fields

Authorizations

Body

Response

​Additional Required Fields

Authorizations

Body

Response

Additional Required Fields