Month summary
get_monthly_summaryReview a YNAB month at a glance: income, budgeted, spent, Ready to Assign, and overspent categories in one read-only request.
Instructions
A month at a glance: income, budgeted, spent, Ready to Assign, overspent categories.
Use it first to review a month. Amounts in currency units; activity is negative for spending. Only overspent categories are listed: use get_category_balances for all of them, get_spending_trends to compare with earlier months, and forecast_balance for the months ahead. One YNAB request; changes nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | 'YYYY-MM-01' or 'current'. | current |
| plan_id | Yes | YNAB plan id or 'last-used'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | Yes | First day of the month, YYYY-MM-01. | |
| income | Yes | Money received in the month and assigned to Ready to Assign. | |
| activity | Yes | Total spent (negative) and received in categories during the month. | |
| budgeted | Yes | Total assigned to categories in the month. | |
| overspent | Yes | Categories whose available balance is negative this month. | |
| age_of_money | Yes | Days between receiving money and spending it, as YNAB computes it; null when unknown. | |
| ready_to_assign | Yes | Money not yet given a job; negative when more was assigned than received. |