Skip to main content
GET
/
api
/
banking
/
exclude
Retrieves the excluded bank transactions.
curl --request GET \
  --url https://api.example.com/api/banking/exclude \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "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 ' 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.

Query Parameters

page
number

Page number

Example:

1

pageSize
number

Page size

Example:

25

accountId
number

Filter by bank account ID

Example:

1

minDate
string

Minimum date (ISO)

Example:

"2024-01-01"

maxDate
string

Maximum date (ISO)

Example:

"2024-12-31"

minAmount
number

Minimum amount

Example:

0

maxAmount
number

Maximum amount

Example:

10000

Response

200 - application/json

The excluded bank transactions has been retrieved successfully.

pagination
object
required

Pagination metadata

data
object[]