Aggregate transactions
aggregate_transactionsGroup and total transactions by merchant, category, code, or time period. Returns counts, total and net amounts for spending insights.
Instructions
Group and total transactions server-side: by merchant, category, code and/or one of day/month/year. Returns per-group counts, totalAmountMinor (magnitude of all items) and netAmountMinor (credits minus debits, signed). Minor units; with no period filter the last 3 months are used. The go-to tool for questions like "top categories by spend this quarter" or "monthly spend at Tesco".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End of period, exclusive. RFC3339 or "YYYY-MM-DD". | |
| from | No | Start of period, inclusive. RFC3339 or "YYYY-MM-DD". | |
| page | No | ||
| size | No | Page size, default 50, max 200. | |
| type | No | DEBIT = money out, CREDIT = money in. | |
| codes | No | Transaction codes, e.g. DIRECT_DEBIT, TRANSFER, PURCHASE. | |
| query | No | Free-text search across merchant name and description. | |
| sortBy | No | Default: totalAmount. | |
| groupBy | Yes | Grouping keys; at most one of day/month/year. | |
| minItems | No | Only return groups with at least this many transactions. | |
| merchantId | No | ||
| monthStart | No | A single calendar month "YYYY-MM"; alternative to from/to. | |
| categoryIds | No | Only items the user has categorised with these category ids. | |
| hasCategory | No | true = only user-categorised items; false = only items without one. | |
| merchantName | No | Exact merchant name (case-insensitive). | |
| sortDirection | No | Default: desc. | |
| maxAmountMinor | No | ||
| minAmountMinor | No | Minimum amount in minor units (inclusive). Amounts are unsigned. | |
| linkedToHoldingId | No | Only items linked to this holding. | |
| effectiveCategoryIds | No | Only items whose effective category (user-set, else auto-suggested) is one of these ids. |