v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Cash Management

List Bank Transactions

    Retrieve a paginated list of bank transactions with optional filtering.

    Supports including soft-deleted records for audit and recovery purposes.
    When include_deleted=true, deleted records will have is_deleted=true
    and include deletion metadata (deleted_at timestamp).
    
get/ca/api/transaction

Query parameters

exclude_draftsboolean

If true, hide bank transactions that have a pending cash-application DraftQueue attached (match drafts or categorize drafts). Default false.

include_deletedboolean

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}