Create category
create_categoryCreates a YNAB category within a specified category group and can set an optional savings target, helping organize budget categories and goals.
Instructions
Create a category in a category group, optionally with a target.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Category name (required) | |
| note | No | Category note (optional) | |
| target_date | No | Date the target amount should be reached, for a balance by a date. Cannot be combined with target_frequency (optional) | |
| target_amount | No | Target amount in currency units. Setting it on a category with no target creates a monthly NEED target (optional) | |
| target_frequency | No | Make a repeating NEED target of target_amount every "weekly", "monthly", or "yearly". Requires target_amount (optional) | |
| category_group_id | Yes | Group to create the category in (required) | |
| target_needs_whole_amount | No | For NEED targets, whether the whole target is needed every period (true) or the rollover counts toward it (false) (optional) |
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 |