GET
/
api
/
banking
/
exclude
[
  {
    "amount": 123,
    "date": {},
    "accountId": 123,
    "referenceNo": "<string>",
    "payee": "<string>",
    "description": "<string>",
    "plaidTransactionId": "<string>",
    "pending": true,
    "recognizedTransactionId": 123,
    "categorizeRefType": "<string>",
    "categorizeRefId": 123,
    "formattedAmount": "<string>",
    "formattedDate": "<string>",
    "formattedDepositAmount": "<string>",
    "formattedWithdrawalAmount": "<string>",
    "withdrawal": 123,
    "deposit": 123,
    "isDepositTransaction": true,
    "isWithdrawalTransaction": true,
    "isRecognized": true,
    "isExcluded": true,
    "isPending": true,
    "assignedAccountId": 123,
    "assignedAccountName": "<string>",
    "assignedAccountCode": "<string>",
    "assignedPayee": "<string>",
    "assignedMemo": "<string>",
    "assignedCategory": "<string>",
    "assignedCategoryFormatted": "<string>"
  }
]

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.

Response

200 - application/json

The excluded bank transactions has been retrieved successfully.

​
amount
number
required

Transaction amount (positive for deposit, negative for withdrawal)

​
date
object
required

Transaction date (ISO string or Date)

​
accountId
number
required

ID of the associated bank account

​
referenceNo
string

Reference number for the transaction

​
payee
string

Payee name

​
description
string

Transaction description

​
plaidTransactionId
string

Plaid transaction ID

​
pending
boolean

Whether the transaction is pending

​
recognizedTransactionId
number

ID of the recognized transaction, if any

​
categorizeRefType
string

Categorization reference type

​
categorizeRefId
number

Categorization reference ID

​
formattedAmount
string

Formatted amount (localized string)

​
formattedDate
string

Formatted transaction date

​
formattedDepositAmount
string

Formatted deposit amount

​
formattedWithdrawalAmount
string

Formatted withdrawal amount

​
withdrawal
number

Withdrawal amount

​
deposit
number

Deposit amount

​
isDepositTransaction
boolean

True if deposit transaction

​
isWithdrawalTransaction
boolean

True if withdrawal transaction

​
isRecognized
boolean

True if transaction is recognized

​
isExcluded
boolean

True if transaction is excluded

​
isPending
boolean

True if transaction is pending

​
assignedAccountId
number

Assigned account ID from recognized transaction

​
assignedAccountName
string

Assigned account name from recognized transaction

​
assignedAccountCode
string

Assigned account code from recognized transaction

​
assignedPayee
string

Assigned payee from recognized transaction

​
assignedMemo
string

Assigned memo from recognized transaction

​
assignedCategory
string

Assigned category from recognized transaction

​
assignedCategoryFormatted
string

Assigned formatted category from recognized transaction