Create BankTransfer record

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/bank-transfers/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "debit_bank_account_number": 123,
  "credit_bank_account_number": 123,
  "amount": 1,
  "transaction_date": "2023-12-25",
  "exchange_rate": "1.00",
  "calculate_gain_loss": true,
  "sending_base_rate": 1,
  "receiving_base_rate": 1,
  "memo": "",
  "reference_number": "<string>",
  "record_status": "posted"
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/bank-transfers/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "debit_bank_account_number": 123,
    "credit_bank_account_number": 123,
    "amount": 1,
    "transaction_date": "2023-12-25",
    "exchange_rate": "1.00",
    "calculate_gain_loss": True,
    "sending_base_rate": 1,
    "receiving_base_rate": 1,
    "memo": "",
    "reference_number": "<string>",
    "record_status": "posted"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    company_id: 123,
    debit_bank_account_number: 123,
    credit_bank_account_number: 123,
    amount: 1,
    transaction_date: '2023-12-25',
    exchange_rate: '1.00',
    calculate_gain_loss: true,
    sending_base_rate: 1,
    receiving_base_rate: 1,
    memo: '',
    reference_number: '<string>',
    record_status: 'posted'
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/bank-transfers/', 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.dualentry.com/public/v3-alpha/bank-transfers/",
  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([
    'date' => '2023-12-25',
    'company_id' => 123,
    'debit_bank_account_number' => 123,
    'credit_bank_account_number' => 123,
    'amount' => 1,
    'transaction_date' => '2023-12-25',
    'exchange_rate' => '1.00',
    'calculate_gain_loss' => true,
    'sending_base_rate' => 1,
    'receiving_base_rate' => 1,
    'memo' => '',
    'reference_number' => '<string>',
    'record_status' => 'posted'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-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.dualentry.com/public/v3-alpha/bank-transfers/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}")

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

	req.Header.Add("X-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.dualentry.com/public/v3-alpha/bank-transfers/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/bank-transfers/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}"

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

{
  "internal_id": 123,
  "number": 123,
  "transaction_id": 123,
  "debit_entry_id": 123,
  "credit_entry_id": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "debit_bank_account_number": 123,
  "credit_bank_account_number": 123,
  "amount": "<string>",
  "exchange_rate": "<string>",
  "sending_base_amount": "<string>",
  "receiving_base_amount": "<string>",
  "sending_base_rate": "<string>",
  "receiving_base_rate": "<string>",
  "memo": "<string>",
  "record_status": "draft",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "bank_match_status": "<string>",
  "reconciliation_status": "<string>",
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "calculate_gain_loss": true,
  "base_currency_anchor": "sending",
  "reference_number": "<string>",
  "currency_iso_4217_code": []
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Bank Transfers

Create BankTransfer record

Create a new BankTransfer record with the provided data. Validates all required fields and business rules.

Side effects

If an approval workflow matches this request, DualEntry can set record_status back to draft.
If this record already has an active bank match, and an approval workflow holds the record, DualEntry returns those matches to draft.

Additional validations

Fails with 422 and the error code posting_date_after_limit if date is after the latest posting date that your organization allows.
Fails with 422 if you set an inactive, archived, or draft customer or vendor, or an inactive company.
A reference that the record or its linked source record already holds passes these checks.

POST

public

v3-alpha

bank-transfers

Create BankTransfer record

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/bank-transfers/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "debit_bank_account_number": 123,
  "credit_bank_account_number": 123,
  "amount": 1,
  "transaction_date": "2023-12-25",
  "exchange_rate": "1.00",
  "calculate_gain_loss": true,
  "sending_base_rate": 1,
  "receiving_base_rate": 1,
  "memo": "",
  "reference_number": "<string>",
  "record_status": "posted"
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/bank-transfers/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "debit_bank_account_number": 123,
    "credit_bank_account_number": 123,
    "amount": 1,
    "transaction_date": "2023-12-25",
    "exchange_rate": "1.00",
    "calculate_gain_loss": True,
    "sending_base_rate": 1,
    "receiving_base_rate": 1,
    "memo": "",
    "reference_number": "<string>",
    "record_status": "posted"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    company_id: 123,
    debit_bank_account_number: 123,
    credit_bank_account_number: 123,
    amount: 1,
    transaction_date: '2023-12-25',
    exchange_rate: '1.00',
    calculate_gain_loss: true,
    sending_base_rate: 1,
    receiving_base_rate: 1,
    memo: '',
    reference_number: '<string>',
    record_status: 'posted'
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/bank-transfers/', 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.dualentry.com/public/v3-alpha/bank-transfers/",
  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([
    'date' => '2023-12-25',
    'company_id' => 123,
    'debit_bank_account_number' => 123,
    'credit_bank_account_number' => 123,
    'amount' => 1,
    'transaction_date' => '2023-12-25',
    'exchange_rate' => '1.00',
    'calculate_gain_loss' => true,
    'sending_base_rate' => 1,
    'receiving_base_rate' => 1,
    'memo' => '',
    'reference_number' => '<string>',
    'record_status' => 'posted'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-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.dualentry.com/public/v3-alpha/bank-transfers/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}")

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

	req.Header.Add("X-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.dualentry.com/public/v3-alpha/bank-transfers/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/bank-transfers/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"debit_bank_account_number\": 123,\n  \"credit_bank_account_number\": 123,\n  \"amount\": 1,\n  \"transaction_date\": \"2023-12-25\",\n  \"exchange_rate\": \"1.00\",\n  \"calculate_gain_loss\": true,\n  \"sending_base_rate\": 1,\n  \"receiving_base_rate\": 1,\n  \"memo\": \"\",\n  \"reference_number\": \"<string>\",\n  \"record_status\": \"posted\"\n}"

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

{
  "internal_id": 123,
  "number": 123,
  "transaction_id": 123,
  "debit_entry_id": 123,
  "credit_entry_id": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "debit_bank_account_number": 123,
  "credit_bank_account_number": 123,
  "amount": "<string>",
  "exchange_rate": "<string>",
  "sending_base_amount": "<string>",
  "receiving_base_amount": "<string>",
  "sending_base_rate": "<string>",
  "receiving_base_rate": "<string>",
  "memo": "<string>",
  "record_status": "draft",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "bank_match_status": "<string>",
  "reconciliation_status": "<string>",
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "calculate_gain_loss": true,
  "base_currency_anchor": "sending",
  "reference_number": "<string>",
  "currency_iso_4217_code": []
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

Idempotency-Key

string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Query Parameters

apply_default_classifications

boolean

default:true

When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.

Body

application/json

Input schema for creating BankTransfer records.

date

string<date>

required

company_id

integer

required

debit_bank_account_number

integer

required

credit_bank_account_number

integer

required

amount

required

Required range: x > 0

transaction_date

string<date> | null

exchange_rate

default:1.00

calculate_gain_loss

boolean

default:true

base_currency_anchor

enum<string> | null

Available options:

sending,

receiving

sending_base_rate

Required range: x > 0

receiving_base_rate

Required range: x > 0

memo

string

default:""

reference_number

string | null

Required string length: 1 - 128

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

Response

internal_id

integer

required

number

integer

required

transaction_id

integer

required

debit_entry_id

integer

required

credit_entry_id

integer

required

date

string<date>

required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_date

string<date>

required

Transaction date (inception date) - the date when the transaction actually occurred

company_id

integer

required

company_name

string

required

company_currency

string

required

debit_bank_account_number

integer | null

required

credit_bank_account_number

integer | null

required

amount

string

required

Transfer amount

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

exchange_rate

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$

sending_base_amount

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

receiving_base_amount

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

sending_base_rate

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$

receiving_base_rate

string

required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$

memo

string

required

record_status

enum<string>

required

Available options:

draft,

posted,

archived

created_at

string<date-time>

required

Date and time the record was created

updated_at

string<date-time>

required

Date and time the record was last updated

bank_match_status

string | null

reconciliation_status

string | null

created_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

updated_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

code

string | null

calculate_gain_loss

boolean

default:true

base_currency_anchor

enum<string> | null

Available options:

sending,

receiving

reference_number

string | null

currency_iso_4217_code

string[]

Overview

Organization

Accounting Setup

Transactions

Money In

Money Out

Financial & Banking

Assets

Tax

Financial Planning

Reporting

Governance

Developers

Monitoring

OAuth

Create BankTransfer record

Authorizations

Headers

Query Parameters

Body

Response