Months — Get
months_getFetch one month's categories with their budgeted, activity, and balance amounts. Use compact mode for month-over-month reviews, or include hidden categories for credit-card payments.
Instructions
[READ] Get one month's categories with their budgeted, activity, and balance. month: ISO date for the first day of the month ('2024-01-01'), 'YYYY-MM', or 'current'. compact=true returns only id, group, name, budgeted, activity and balance per category — about a quarter of the size, and enough for any month-over-month review. Use the full form only when you need goal fields or notes. include_hidden=true adds hidden categories, which is where YNAB keeps the credit-card payment categories; deleted categories are never returned. To compare several months, use months_range instead (up to 36 months in one call). Amounts are in milliunits (1000 = $1.00).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | Yes | ||
| compact | No | ||
| plan_id | No | ||
| include_hidden | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||