Get plan month
get_plan_monthRetrieve one month of YNAB plan data, including income, assigned amounts, activity, Ready to Assign, age of money, and visible category balances for current, last, next, or a specified month.
Instructions
Get one month of the plan: income, assigned, activity, Ready to Assign, age of money, and each visible category's amounts for that month.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of categories to return per page (default: 50) | |
| month | No | Which plan month (default: "current"): • "current": This calendar month • "last": The previous calendar month • "next": The next calendar month • A date: The month containing that date, such as 2024-03-01 | current |
| offset | No | Number of categories to skip for pagination (default: 0) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | The user's note for this month | |
| month | Yes | First day of the plan month | |
| income | Yes | Income categorized to 'Inflow: Ready to Assign' | |
| activity | Yes | Total activity, excluding income to Ready to Assign | |
| assigned | Yes | Total assigned across categories | |
| categories | Yes | Categories with their amounts for this month | |
| pagination | Yes | Pagination information for the categories | |
| age_of_money | No | Age of money in days: how long money sits before it is spent | |
| ready_to_assign | Yes | Money not yet assigned to a category (can be negative) |