Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Cash Management

List Bank Accounts

    Retrieve a paginated list of bank accounts.

    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).

    Supports sorting by all returned fields:
    - name, -name (account name)
    - nickname, -nickname (account nickname)
    - type, -type (account type)
    - status, -status (account status)
    - currency, -currency (account currency)
    - external_account_id, -external_account_id (external account ID)
    - institution_id, -institution_id (institution ID)
    - source, -source (account source)
    - current_balance, -current_balance (current balance)
    - available_balance, -available_balance (available balance)
    - created_at, -created_at (creation date)
    - last_modified_at, -last_modified_at (last modified date)
    - account_type, -account_type (chart account type)
    - account_subtype, -account_subtype (chart account subtype)
    - account_cashflow_classification, -account_cashflow_classification (cashflow classification)
    - type_name, -type_name (human-readable account type)
    - subtype_name, -subtype_name (human-readable account subtype)
    - cashflow_classification_name, -cashflow_classification_name (human-readable cashflow classification)
    - entity_name, -entity_name (entity name)
    - department, -department (department name)
    - id, -id (account ID)
    - account_id, -account_id (UUID account ID)
get/ca/api/account

Query parameters

chart_of_accounts_accountinteger

Filter bank accounts by their linked chart of accounts account ID

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.

last_modified_at__gtestring

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__ltestring

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

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"
}