Accounts
Where it lives: at accounts in the Financial Position, and on its own from the accounts endpoint.
The account is the centre of a banking extraction: it carries the balances, and it carries the movements that everything else is inferred from — income, rent, recurring commitments, unusual activity.
Product ID for the current execution. Note: it may change between executions.
Two balances, and they are not interchangeable
booked— the settled balance: what has actually cleared. This is the figure the institution shows as “balance”.available— what can be spent right now: the booked balance adjusted for pending movements and any credit line attached to the account.
For solvency, booked is the honest number. For “can this payment go through today”, available is.
Holders
Who the account belongs to, and in what capacity — the difference between a sole account and one held with somebody else, which matters for both affordability and identity checks.
Transactions
Transactions are only retrieved when the feature is configured to read them (read_transactions, with a date range). Each one carries its dates, its amount, the running balance after it, and the parties involved.
Represents the exact moment a transaction was initiated or authorized, regardless of when it was recorded or had an effect on the balance. For instance, if a purchase was made using a credit card, the operation_date would be the date of that purchase, even if the transaction was processed or reflected in the account on subsequent dates.
The date on which the transaction effectively impacts an account balance. It determines when interests or other time-based considerations might commence. Even though a transaction might be logged or authorized on a different date, the value_date signifies the point when it truly reflects on the account’s funds.
Every transaction arrives categorised
category is a two-level classification applied on top of what the bank published, in a fixed vocabulary — income::income::salary & payroll, expenses::household::rent, expenses::transport::car & fuel. It is what lets you compute income, fixed commitments and discretionary spending without writing a rules engine of your own.
Taxonomy of financial transactions for categorization.
Values are family::group::leaf codes and are what gets stored and served. Each
member's docstring is the customer-facing label of that node in the taxonomy.
The prefix is the first thing to branch on: income::, expenses:: or null:: for movements that are neither (internal transfers, card adjustments). Anything the classifier could not place lands in …::to categorize::unclassified rather than being guessed at.
Type and status
How far back the transactions go is decided by two things: the range you asked for in the feature’s configuration, and what the institution itself keeps. The engine’s engine_restrictions state its limit — ask for more and the execution is rejected, unless you set limits_behaviour: adapt.