THthredfi
Bank Transactions Management

List Bank Transactions (Business-scoped)

    Retrieve a paginated list of bank transactions for a specific business with advanced filtering options.

    Authentication:
    - Requires business-scoped Bearer token (ScopedBusinessTokenAuthentication)
    - Token business_id must match the business_id in the path

    **Default Behavior:**
    - Returns bank transactions for the business in the URL path
    - Uses summary serializer for list view (lighter payload)

    **Filtering Options:**

    **Account Filters:**
    - `account_id`: Filter by mapped account ID
    - `bank_account_connection_id`: Filter by bank account connection

    **Date Filters:**
    - `date_from`: Transactions from this date (ISO 8601 format)
    - `date_to`: Transactions to this date (ISO 8601 format)

    **Transaction Filters:**
    - `direction`: Filter by direction (credit/debit)
    - `categorization_status`: Filter by categorization status (supports multiple values)
    - `transaction_type`: Filter by transaction type (one of: fps, bacs, chaps, direct_debit, standing_order, sepa_credit, sepa_debit, sepa_instant, card_payment, atm_withdrawal, bank_transfer, fee, interest, other)
    - `source`: Filter by transaction source
    - `currency`: Filter by currency (GBP, EUR, USD)

    **Amount Filters:**
    - `amount_min`: Minimum transaction amount in cents
    - `amount_max`: Maximum transaction amount in cents

    **Status Filters:**
    - `is_reconciled`: Filter by reconciliation status
    - `needs_categorization`: Filter transactions needing categorization
    - `is_categorized`: Filter categorized transactions
    - `has_parent`: Filter split transactions
    - `has_children`: Filter transactions with splits

    **Search:**
    - `search`: Search across description, counterparty, merchant, and reference

    **Ordering:**
    - `ordering`: Order by any field (prefix with '-' for descending)
    - Default: `-date, -created_at` (newest first)

    **Examples:**
    - Get credit transactions: `?direction=credit`
    - Get pending categorization: `?categorization_status=pending`
    - Get multiple statuses: `?categorization_status=pending&categorization_status=manual_review`
    - Get transactions for date range: `?date_from=2025-01-01&date_to=2025-01-31`
    - Search transactions: `?search=amazon`
    - Filter by amount: `?amount_min=10000&amount_max=100000` (amounts in cents)
get/v1/platform/businesses/{business_id}/bank-transactions/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring required

Business ID (UUID format) in path

Query parameters

account_idstring

Filter by mapped account ID (UUID format)

amount_maxinteger

Filter by maximum amount in cents

amount_mininteger

Filter by minimum amount in cents

approval_statusstring[]

Filter by approval status (supports multiple values: ?approval_status=pending_approval&approval_status=ai_approved)

  • pending_approval - Pending Approval
  • ai_approved - AI Approved
  • approved - Approved
bank_account_connection_idstring

Filter by bank account connection ID (UUID format)

business_idstring uuid

Filter by business ID

categorization_status'approved' | 'categorized' | 'manual_review' | 'pending'

Filter by categorization status (supports multiple values)

category_codestring

Filter by category code

category_idstring uuid

Filter by category ID

currency'EUR' | 'GBP' | 'USD'

Filter by currency

date_fromstring

Filter transactions from this date (ISO 8601 format)

date_tostring

Filter transactions to this date (ISO 8601 format)

direction'credit' | 'debit'

Filter by transaction direction

has_childrenboolean

Filter transactions that have child splits

has_parentboolean

Filter transactions that are split from parent

is_categorizedboolean

Filter transactions that are categorized

is_reconciledboolean

Filter by reconciliation status

needs_categorizationboolean

Filter transactions that need categorization

orderingstring

Order by field (prefix with - for descending)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Search in description, counterparty, merchant, and reference

source'api' | 'csv_import' | 'manual' | 'open_banking' | 'plaid'

Filter by transaction source

subcategory_codestring

Filter by subcategory code

subcategory_idstring uuid

Filter by subcategory ID

transaction_type'atm_withdrawal' | 'bacs' | 'bank_transfer' | 'card_payment' | 'chaps' | 'direct_debit' | 'fee' | 'fps' | 'interest' | 'other' | 'sepa_credit' | 'sepa_debit' | 'sepa_instant' | 'standing_order'

Filter by transaction type

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.