Skip to main content
POST
/
api
/
banking
/
transactions
Create a new bank transaction
curl --request POST \
  --url https://api.example.com/api/banking/transactions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "date": "2023-01-01T00:00:00.000Z",
  "transactionType": "deposit",
  "description": "Monthly rent payment",
  "amount": 1000.5,
  "exchangeRate": 1.15,
  "creditAccountId": 1001,
  "cashflowAccountId": 2001,
  "publish": true,
  "transactionNumber": "TRX-001",
  "referenceNo": "REF-001",
  "currencyCode": "USD",
  "branchId": 101,
  "plaidTransactionId": "plaid_trx_12345",
  "plaidAccountId": "plaid_acc_67890",
  "uncategorizedTransactionId": 5001
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
date
string<date-time>
required

The date of the bank transaction

Example:

"2023-01-01T00:00:00.000Z"

​
transactionType
string
required

Type of bank transaction (e.g., deposit, withdrawal)

Example:

"deposit"

​
description
string
required

Description of the bank transaction

Example:

"Monthly rent payment"

​
amount
number
required

Transaction amount

Example:

1000.5

​
exchangeRate
number
default:1
required

Exchange rate for currency conversion

Example:

1.15

​
creditAccountId
number
required

ID of the credit account associated with this transaction

Example:

1001

​
cashflowAccountId
number
required

ID of the cashflow account associated with this transaction

Example:

2001

​
publish
boolean
default:true
required

Whether the transaction should be published

​
transactionNumber
string

Optional transaction number or reference

Example:

"TRX-001"

​
referenceNo
string

Optional external reference number

Example:

"REF-001"

​
currencyCode
string

Currency code for the transaction

Example:

"USD"

​
branchId
number

ID of the branch where the transaction occurred

Example:

101

​
plaidTransactionId
string

Plaid transaction ID if imported from Plaid

Example:

"plaid_trx_12345"

​
plaidAccountId
string

Plaid account ID if imported from Plaid

Example:

"plaid_acc_67890"

​
uncategorizedTransactionId
number

ID of the uncategorized transaction if this is categorizing an existing transaction

Example:

5001

Response

The bank transaction has been successfully created