GET
/
api
/
banking
/
recognized
[
  {
    "uncategorizedTransactionId": 123,
    "referenceNo": "TRX-2024-001",
    "description": "Payment for invoice #123",
    "payee": "John Doe",
    "amount": 1500.75,
    "formattedAmount": "$1,500.75",
    "date": "2024-04-01",
    "formattedDate": "Apr 1, 2024",
    "assignedAccountId": 10,
    "assignedAccountName": "Bank Account",
    "assignedAccountCode": "1001",
    "assignedPayee": "Jane Smith",
    "assignedMemo": "Office supplies",
    "assignedCategory": "Office Expenses",
    "assignedCategoryFormatted": "Other Income",
    "withdrawal": 500,
    "deposit": 1000,
    "isDepositTransaction": true,
    "isWithdrawalTransaction": false,
    "formattedDepositAmount": "$1,000.00",
    "formattedWithdrawalAmount": "$500.00",
    "bankRuleId": "BR-001",
    "bankRuleName": "Salary Rule"
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> 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.

Query Parameters

​
query
any

Query parameters for filtering recognized transactions

Response

200 - application/json

Returns a list of recognized transactions

​
uncategorizedTransactionId
number
required

The unique identifier of the uncategorized transaction

Example:

123

​
referenceNo
string
required

The reference number of the transaction

Example:

"TRX-2024-001"

​
description
string
required

The description of the transaction

Example:

"Payment for invoice #123"

​
payee
string
required

The payee of the transaction

Example:

"John Doe"

​
amount
number
required

The amount of the transaction

Example:

1500.75

​
formattedAmount
string
required

The formatted amount of the transaction

Example:

"$1,500.75"

​
date
string
required

The date of the transaction

Example:

"2024-04-01"

​
formattedDate
string
required

The formatted date of the transaction

Example:

"Apr 1, 2024"

​
assignedAccountId
number
required

The assigned account ID

Example:

10

​
assignedAccountName
string
required

The assigned account name

Example:

"Bank Account"

​
assignedAccountCode
string
required

The assigned account code

Example:

"1001"

​
assignedPayee
string
required

The assigned payee

Example:

"Jane Smith"

​
assignedMemo
string
required

The assigned memo

Example:

"Office supplies"

​
assignedCategory
string
required

The assigned category

Example:

"Office Expenses"

​
assignedCategoryFormatted
string
required

The formatted assigned category

Example:

"Other Income"

​
withdrawal
number
required

The withdrawal amount

Example:

500

​
deposit
number
required

The deposit amount

Example:

1000

​
isDepositTransaction
boolean
required

Whether this is a deposit transaction

Example:

true

​
isWithdrawalTransaction
boolean
required

Whether this is a withdrawal transaction

Example:

false

​
formattedDepositAmount
string
required

The formatted deposit amount

Example:

"$1,000.00"

​
formattedWithdrawalAmount
string
required

The formatted withdrawal amount

Example:

"$500.00"

​
bankRuleId
string
required

The bank rule ID

Example:

"BR-001"

​
bankRuleName
string
required

The bank rule name

Example:

"Salary Rule"