Bank Statement API

What this module provides

Framework module that lets KitWorks bank-API integrations share credential storage, scheduled sync, per-journal sync status and HTTP request logging. This module imports no transactions on its own — install one of the bank-specific API modules (Monobank, Privat24 Business, Ukrgasbank) to start syncing.

Category: Hidden/Tools. This is a dependency for the KitWorks Bank Statement Suite, not a stand-alone end-user feature.

Architecture

• Adds kw.bank.statement.credential (inherits kw.api.credential): per-company API credentials (auth_client_id, auth_token) bound to one or many account.journal records.
• Adds kw.bank.statement.connector (inherits kw.api.connector): bank metadata (bank_code / MFO, allowed currencies, is_client_id_used) used by child modules to register a specific bank API.
• Extends account.journal with API status fields: kw_bst_api_credential_id, kw_bst_api_enabled, kw_bst_api_account_filter (IBAN), kw_bst_api_sync_from_date, kw_bst_api_last_sync_date, kw_bst_api_sync_status (draft / active / error / paused), kw_bst_api_last_error.
• Provides stub methods test_connection, fetch_accounts, fetch_statements dispatched to bank-specific implementations via the @use_fname() decorator.
• Orchestrates a cron-driven statement_sync(journal) and kw_bst_cron_sync that processes one journal per call (oldest-sync-first), then writes results through the base module’s deduplication layer.
• Logs HTTP requests / responses to kw.http.request.log.source (default 30-day retention, 10000-char body) for traceability of bank API calls.

Used by

These KitWorks Bank Statement modules depend on this module:

Need help?

Kitworks Systems supports the Bank Statement Suite. Reach out for installation help, bug reports or custom bank integrations.