Liquidity & Cash
Cash Transactions
Required scope: company-cash · Endpoint: GET /cash-transactions
Identifies and summarises cash deposits and cash withdrawals across all company accounts. Transactions are tagged as cash deposits or cash withdrawals during the categorisation step — only those tagged transactions appear in this analysis.
Response structure
| Field | Description |
|---|---|
overview.incomings | Total cash deposits: sum, count, and transaction IDs |
overview.outgoings | Total cash withdrawals: sum, count, and transaction IDs |
overview.totalTransactionAmount | Combined amount of all cash movements |
overview.totalTransactionCount | Total number of cash transactions |
monthlyOverview[] | Same breakdown repeated per calendar month, sorted newest-first |
monthlyOverview[].month | Month in YYYY-MM format |
Liquidity
Required scope: company-liquidity · Endpoint: GET /liquidity
Tracks all income and expenses per account, month by month. Alongside transaction counts and amounts, each monthly entry includes balance snapshots that show how the account balance evolved within that month.
The response contains a cross-account overview and a per-account breakdown under accountLiquidity.
Response structure
Top-level overview (aggregated across all accounts):
| Field | Description |
|---|---|
overview.incomings | Total incoming transactions: sum and count |
overview.outgoings | Total outgoing transactions: sum and count |
overview.totalTransactionAmount | Net combined amount |
overview.totalTransactionCount | Total transaction count |
Per-account entry (accountLiquidity[]):
| Field | Description |
|---|---|
account | Basic account information (IBAN, account type, etc.) |
overview | Same structure as the top-level overview, but scoped to this account |
monthlyOverview[] | Monthly breakdown for this account, sorted newest-first |
monthlyOverview[].month | Month in YYYY-MM format |
monthlyOverview[].endOfMonthBalance | Account balance at the end of the month |
monthlyOverview[].minBalance | Lowest balance recorded during the month |
monthlyOverview[].maxBalance | Highest balance recorded during the month |
monthlyOverview[].incomings | Incoming transactions for the month |
monthlyOverview[].outgoings | Outgoing transactions for the month |
monthlyOverview[].totalTransactionAmount | Net amount for the month |
Foreign Payments
Required scope: company-foreign-payment · Endpoint: GET /foreign-payments
Identifies transactions involving international counterparties — detected by a non-domestic IBAN prefix on the payment partner. Results are grouped by the counterparty's country code.
Response structure
| Field | Description |
|---|---|
overview.incomings | Total international income: sum, count, transaction IDs |
overview.outgoings | Total international expenses: sum, count, transaction IDs |
overview.totalTransactionAmount | Combined total of all international transactions |
overview.totalTransactionCount | Total count of international transactions |
byState[] | Breakdown by country code (ISO 3166-1 alpha-2), sorted alphabetically |
byState[].code | Two-letter country code derived from the IBAN |
byState[].incomings | International income from this country |
byState[].outgoings | International expenses to this country |