Create Bank Transaction

Create a new bank transaction.

POST /accounting/bank_transactions

Create Bank Transaction

cURL

curl --request POST \
  --url https://api.rootfi.dev/accounting/bank_transactions \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1,
  "data": [
    {
      "account_id": "123456",
      "contact_id": "123456",
      "transaction_date": "2021-09-28T15:00:00.000Z",
      "amount": 100,
      "type": "DEPOSIT",
      "currency_id": "GBP"
    }
  ]
}
'

import requests

url = "https://api.rootfi.dev/accounting/bank_transactions"

payload = {
    "company_id": 1,
    "data": [
        {
            "account_id": "123456",
            "contact_id": "123456",
            "transaction_date": "2021-09-28T15:00:00.000Z",
            "amount": 100,
            "type": "DEPOSIT",
            "currency_id": "GBP"
        }
    ]
}
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: 1,
    data: [
      {
        account_id: '123456',
        contact_id: '123456',
        transaction_date: '2021-09-28T15:00:00.000Z',
        amount: 100,
        type: 'DEPOSIT',
        currency_id: 'GBP'
      }
    ]
  })
};

fetch('https://api.rootfi.dev/accounting/bank_transactions', 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/accounting/bank_transactions",
  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' => 1,
    'data' => [
        [
                'account_id' => '123456',
                'contact_id' => '123456',
                'transaction_date' => '2021-09-28T15:00:00.000Z',
                'amount' => 100,
                'type' => 'DEPOSIT',
                'currency_id' => 'GBP'
        ]
    ]
  ]),
  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/accounting/bank_transactions"

	payload := strings.NewReader("{\n  \"company_id\": 1,\n  \"data\": [\n    {\n      \"account_id\": \"123456\",\n      \"contact_id\": \"123456\",\n      \"transaction_date\": \"2021-09-28T15:00:00.000Z\",\n      \"amount\": 100,\n      \"type\": \"DEPOSIT\",\n      \"currency_id\": \"GBP\"\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/accounting/bank_transactions")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1,\n  \"data\": [\n    {\n      \"account_id\": \"123456\",\n      \"contact_id\": \"123456\",\n      \"transaction_date\": \"2021-09-28T15:00:00.000Z\",\n      \"amount\": 100,\n      \"type\": \"DEPOSIT\",\n      \"currency_id\": \"GBP\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": 1,\n  \"data\": [\n    {\n      \"account_id\": \"123456\",\n      \"contact_id\": \"123456\",\n      \"transaction_date\": \"2021-09-28T15:00:00.000Z\",\n      \"amount\": 100,\n      \"type\": \"DEPOSIT\",\n      \"currency_id\": \"GBP\"\n    }\n  ]\n}"

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

200

{
  "data": {
    "status": "SUCCESS",
    "upload_job_id": "xQm2K441VosP8W4",
    "data": [
      {
        "job_id": "aXI9pUDA5T7E2LS",
        "status": "success",
        "response": {
          "platform_id": "3770712000000893001",
          "account_id": "3770712000000493001",
          "contact_id": "3770712000000225001",
          "from_account_id": "3770712000000493001",
          "to_account_id": "3770712000000493001",
          "debit_or_credit": "CREDIT",
          "transaction_date": "2022-02-17T00:00:00.000Z",
          "amount": 112345,
          "type": "deposit",
          "status": "manually_added",
          "updated_at": "2022-02-17T00:00:00.000Z",
          "raw_data": {
            "id": "3770712000000893001",
            "account_id": "3770712000000493001",
            "contact_id": "3770712000000225001",
            "transaction_date": "2022-02-17",
            "amount": "112345.00",
            "type": "deposit",
            "updated_at": "2022-02-17T00:00:00.000Z"
          }
        },
        "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"
}

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 company ID

Example:

1

data · accountingtypesBankTransactionWriteRequestFields · object[] · required

The data to be passed through to the integration platform

Show child attributes

Response

200 - application/json

data · accountingtypesCreateBankTransactionResponseData · 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