Plan Summary
ynab_plan_summarySummarize a YNAB plan month to identify overspent categories needing attention and positive-balance categories, and optionally compare budgeted versus actual spending with variance and percent used.
Instructions
Get a summary of the plan for a specific month highlighting overspent categories that need attention and categories with a positive balance that are doing well. Set budgetVsActuals to also compare assigned with actual spending that month: budgeted, activity, balance, variance (budgeted plus activity; below zero means more was spent than assigned) and percent used for every visible category, with subtotals per category group and overall totals, which leave out Credit Card Payments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | The plan month in ISO format (e.g. 2016-12-01). The string 'current' can also be used to specify the current calendar month (UTC) | |
| planId | No | The plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias) | |
| budgetId | No | Deprecated alias of planId (still accepted) | |
| budgetVsActuals | No | Add a budget_vs_actuals block comparing assigned with actual spending per category for the month, with group subtotals (default: false) |