Skip to main content
POST
/
api
/
banking
/
categorize
Categorize bank transactions.
curl --request POST \
  --url https://api.example.com/api/banking/categorize \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "date": "2023-01-01T00:00:00.000Z",
  "creditAccountId": 1001,
  "transactionType": "deposit",
  "uncategorizedTransactionIds": [
    1001,
    1002,
    1003
  ],
  "referenceNo": "REF-001",
  "transactionNumber": "TRX-001",
  "exchangeRate": 1.15,
  "currencyCode": "USD",
  "description": "Monthly rent payment",
  "branchId": 101
}
'

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"

​
creditAccountId
number
required

ID of the credit account associated with this transaction

Example:

1001

​
transactionType
string
required

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

Example:

"deposit"

​
uncategorizedTransactionIds
number[]
required

Array of uncategorized transaction IDs to be categorized

Example:
[1001, 1002, 1003]
​
referenceNo
string

Optional external reference number

Example:

"REF-001"

​
transactionNumber
string

Optional transaction number or reference

Example:

"TRX-001"

​
exchangeRate
number
default:1

Exchange rate for currency conversion

Example:

1.15

​
currencyCode
string

Currency code for the transaction

Example:

"USD"

​
description
string

Description of the bank transaction

Example:

"Monthly rent payment"

​
branchId
number

ID of the branch where the transaction occurred

Example:

101

Response

200

The bank transactions have been categorized successfully.