Spending / income report
summarize_transactionsAggregate expenses and income by category, payee, account, or time with totals, counts, and shares. Transfers and debts excluded; amounts converted to report currency.
Instructions
Aggregate expenses and/or income by category, parent category, payee, account or time (day/week/month/year) with totals, counts and shares. measure=both gives income, expense and net per group (cash flow). Transfers and debts are excluded; amounts are converted with current rates. By default only in-balance accounts count, like ZenMoney reports.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Max groups for non-time groupings; the rest is rolled up | |
| payee | No | Substring of the payee / merchant name | |
| types | No | Transaction types to include: expense | income | transfer (between own accounts) | debt_out (money given to a person: lending, or repaying them) | debt_in (money received from a person: borrowing, or them repaying you) | |
| period | No | Date range relative to today (weeks start on Monday). date_from/date_to override either end. | |
| search | No | Free text matched against payee, merchant, comment and category names | |
| date_to | No | Inclusive end date, YYYY-MM-DD | |
| measure | No | expense | |
| accounts | No | Account names, ids or card last digits; matches money leaving or arriving | |
| currency | No | Only transactions in this currency (ISO code) | |
| group_by | No | category | |
| date_from | No | Inclusive start date, YYYY-MM-DD | |
| categories | No | Category names, "Parent / Child" paths or ids; subcategories are included | |
| max_amount | No | Maximum amount in the account's currency | |
| min_amount | No | Minimum amount in the account's currency | |
| uncategorized | No | Only transactions without a category | |
| report_currency | No | ISO code to report in; defaults to the main currency | |
| include_off_balance | No | Also count accounts excluded from the balance |