Category Breakdowns
Credits, insurances, investments, and internal bookings all use the same response structure. The analysis detects recurring financial obligations from transactions and contract data, then provides current, median, and average monthly amounts alongside a full monthly history.
Shared Response Structure
| Field | Description |
|---|---|
available | true if the analysis found relevant data; false if nothing was detected |
current | Monthly amount for the most recent complete month |
median | Median monthly amount across the observed timespan |
average | Average monthly amount across the observed timespan |
monthlyOverview[] | Monthly breakdown, sorted newest-first |
monthlyOverview[].month | Month in YYYY-MM format |
monthlyOverview[].amount | Total amount for the month (recurring + non-recurring) |
monthlyOverview[].recurringAmount | Amount from recurring transactions/contracts |
monthlyOverview[].nonRecurringAmount | Amount from one-off transactions |
monthlyOverview[].recurringTransactionIDs | IDs of recurring transactions |
monthlyOverview[].nonRecurringTransactionIDs | IDs of one-off transactions |
contractSummary[] | List of detected contracts contributing to this analysis |
observedTimespan | Date range of the underlying data |
Credits, Loans & Leasing
Required scope: company-credit · Endpoint: GET /credits
Covers all credit-related payments: loan instalments, credit line drawdowns, and leasing payments. Detected from both contract data and tagged transactions.
Insurances
Required scope: company-insurance · Endpoint: GET /insurances
Covers insurance payments. Detected from contract data and tagged transactions categorised as insurance products.
Investments
Required scope: company-investment · Endpoint: GET /investments
Covers savings plans, securities purchases, and other investment contributions. Includes both regular savings plan instalments and one-off investment transactions.
Internal Bookings
Required scope: company-internal-booking · Endpoint: GET /internal-bookings
Detects transfers between accounts that belong to the same company (i.e. accounts present in the same analysis context). These are typically treasury transfers or inter-account settlements.