Get month category
get_month_categoryRetrieve a YNAB category’s assigned, activity, available, and target amounts for a chosen month, including current, last, next, or a specific date.
Instructions
Get one category's assigned, activity, available, and target for a month.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 |
| category_id | Yes | Category to look up (required) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique category identifier | |
| name | Yes | Category name | |
| note | No | Category notes | |
| activity | No | Activity this month (negative = spending) | |
| assigned | No | Amount assigned this month | |
| internal | No | Whether YNAB manages this category itself. 'Inflow: Ready to Assign' is internal: categorize income to it. | |
| available | No | Amount available to spend, including rollover | |
| target_date | No | Date the target should be met, for targets with a date | |
| target_type | No | Target type: NEED (needed for spending, refills each period), TB (have a balance), TBD (have a balance by a date), MF (fund monthly), DEBT (pay down a debt) | |
| target_amount | No | Target amount | |
| category_group_id | Yes | Category group ID | |
| target_underfunded | No | Amount still needed this month to stay on track | |
| category_group_name | No | Category group name | |
| target_overall_left | No | Amount still needed to meet the target this period | |
| target_percentage_complete | No | How much of the target is funded, as a percentage |