Summarise transactions
Totals over the transactions /transactions lists, with the same filters, per period
bucket and at most one more dimension.
The counting rules are fixed so the figures match ThinkOut: transfers between the
workspace’s own accounts and transactions the user excluded are left out, and split
transactions count through their pieces. /transactions lists every movement, so
summing it gives a different figure.
Amounts convert to currency at the rate of each transaction’s own date. Buckets are
calendar aligned and clipped to the window. totals covers the whole window.
Rows grouped by period alone also carry the period’s starting balance, transfers,
excluded movements and final balance. Those four are null when group_by or
direction is given.
Grouped rows are ordered by absolute net, largest first. A period keeps at most 50
groups; the rest fold into one row labelled other. Transactions with no counterparty
or no label fall in a none row, and a transaction with several labels counts once per
label. Here category_id also covers subcategories.
Filters combine with AND; a filter that takes a list combines its values with OR.
Inflows and outflows per month, with balances
Outflows per counterparty per month
Cash flow per month for one bank’s accounts
Authorizations
A workspace API key created in ThinkOut settings. One key reads one workspace.
Query Parameters
First day of the window, inclusive.
Last day of the window, inclusive.
The period bucket rows are grouped into. A period bucket for report rows.
day, week, month A second dimension to group by, alongside the period bucket. Omit it for one row per period. A dimension to group report rows by, alongside the period bucket.
category, counterparty, label, account, activity, direction Currency to report in. Defaults to the workspace currency. An unknown code is rejected. ISO 4217 alphabetic currency code.
^[A-Z]{3}$"RON"
Only rows on the accounts fed by these bank connections. Comma-separated for several.
Only rows on these accounts. Comma-separated for several.
Only rows in these categories. Comma-separated for several. On /transactions this
also matches a split transaction whose pieces are in one of them. Subcategories are
included only on the summaries.
Only rows carrying at least one of these labels. Comma-separated for several.
Only rows attributed to these counterparties. Comma-separated for several.
Whether money comes in or goes out. On a transaction or forecast it follows the sign of amount.
inflow, outflow Only rows whose category sits in these cash flow statement sections. Comma-separated for several.
Cash flow statement section the category belongs to.
operating, investing, financing Response
The summary.
"summary"The window actually computed.
What was done to make amounts comparable.
A dimension to group report rows by, alongside the period bucket.
category, counterparty, label, account, activity, direction false when no transaction matched, as opposed to totals that came to zero.
The whole window added up, after the same exclusions as the rows.