YNAB API coverage

Generated

Generated by python -m docsgen: the tools and resources are found by following the code; api/coverage.toml says why the other operations are planned or left out. A test fails when an operation is not classified, and a weekly check fails when YNAB changes its API.

Source: YNAB’s OpenAPI specification, documented at api.ynab.com. YNAB renamed budgets to plans (announcement): the operations say plan.

YNAB’s API 1.87.0 has 44 operations: 14 used by avenir-mcp, 13 planned, 17 left out on purpose.

Operation	Status	Tools and resources, or why
GET /plans	covered	list_plans, ynab://plans
GET /plans/{plan_id}	excluded	The whole plan at once: far more than an agent can read; tools fetch the parts they need.
GET /plans/{plan_id}/accounts	covered	apply_categories, create_transactions, find_transactions, forecast_balance, list_accounts, list_scheduled_transactions, reconcile_account, split_transaction, suggest_categories, ynab://plans/{plan_id}/accounts
POST /plans/{plan_id}/accounts	excluded	Accounts are opened in YNAB, where the bank connection is set up.
GET /plans/{plan_id}/accounts/{account_id}	excluded	list_accounts gives every account in the same single request.
GET /plans/{plan_id}/accounts/{account_id}/transactions	excluded	find_transactions filters the plan’s transactions by account, in one request.
GET /plans/{plan_id}/categories	covered	apply_categories, create_category, create_transactions, find_recurring_charges, find_transactions, forecast_balance, list_category_groups, list_scheduled_transactions, reconcile_account, set_category_target, split_transaction, suggest_categories, undo_operation, update_category, ynab://plans/{plan_id}/categories
POST /plans/{plan_id}/categories	covered	create_category
GET /plans/{plan_id}/categories/{category_id}	excluded	The category list gives every category in one request.
PATCH /plans/{plan_id}/categories/{category_id}	covered	set_category_target, undo_operation, update_category
GET /plans/{plan_id}/categories/{category_id}/transactions	excluded	find_transactions filters the plan’s transactions by category, split lines included, in one request.
POST /plans/{plan_id}/category_groups	planned	Create a group, for a category that belongs in none of the existing ones.
PATCH /plans/{plan_id}/category_groups/{category_group_id}	planned	Rename or hide a group.
GET /plans/{plan_id}/money_movement_groups	planned	Moves of money grouped as the user made them, for the monthly review.
GET /plans/{plan_id}/money_movements	planned	Money moved between categories, for the monthly review.
GET /plans/{plan_id}/months	covered	get_spending_trends
GET /plans/{plan_id}/months/{month}	covered	get_budget_vs_actual, get_category_balances, get_monthly_summary, get_spending_trends, move_money, set_category_budget, undo_operation
GET /plans/{plan_id}/months/{month}/categories/{category_id}	excluded	A month’s categories come in one request with the month.
PATCH /plans/{plan_id}/months/{month}/categories/{category_id}	covered	move_money, set_category_budget, undo_operation
GET /plans/{plan_id}/months/{month}/money_movement_groups	planned	Moves of money grouped as the user made them in a month, for the monthly review.
GET /plans/{plan_id}/months/{month}/money_movements	planned	Money moved between categories in a month, for the monthly review.
GET /plans/{plan_id}/months/{month}/transactions	excluded	find_transactions reads the plan’s transactions from a date, in one request.
GET /plans/{plan_id}/payee_locations	excluded	Where a payment was made: personal data that no task needs.
GET /plans/{plan_id}/payee_locations/{payee_location_id}	excluded	Where a payment was made: personal data that no task needs.
GET /plans/{plan_id}/payees	planned	List payees, to clean the names bank imports give them.
POST /plans/{plan_id}/payees	excluded	YNAB creates a payee with the first transaction that names it.
GET /plans/{plan_id}/payees/{payee_id}	excluded	The payee list, once planned, gives every payee in one request.
PATCH /plans/{plan_id}/payees/{payee_id}	planned	Rename a payee, e.g. a bank label into the merchant’s name.
GET /plans/{plan_id}/payees/{payee_id}/payee_locations	excluded	Where a payment was made: personal data that no task needs.
GET /plans/{plan_id}/payees/{payee_id}/transactions	excluded	find_transactions filters the plan’s transactions by payee, whatever the bank label, in one request.
GET /plans/{plan_id}/scheduled_transactions	covered	find_recurring_charges, forecast_balance, list_scheduled_transactions
POST /plans/{plan_id}/scheduled_transactions	planned	Schedule a coming payment, after reading them is in place.
GET /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id}	excluded	list_scheduled_transactions reads every schedule in one request.
PUT /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id}	planned	Change a coming payment, after reading them is in place.
DELETE /plans/{plan_id}/scheduled_transactions/{scheduled_transaction_id}	planned	Cancel a coming payment, after reading them is in place.
GET /plans/{plan_id}/settings	planned	The plan’s currency and formats, to show amounts with their currency.
GET /plans/{plan_id}/transactions	covered	apply_categories, find_recurring_charges, find_transactions, flag_transactions, forecast_balance, reconcile_account, split_transaction, suggest_categories, undo_operation
POST /plans/{plan_id}/transactions	covered	create_transactions, reconcile_account
PATCH /plans/{plan_id}/transactions	covered	apply_categories, approve_transactions, flag_transactions, reconcile_account, split_transaction, undo_operation
POST /plans/{plan_id}/transactions/import	covered	import_transactions
GET /plans/{plan_id}/transactions/{transaction_id}	excluded	Transactions are read in one request for the whole plan, then kept in sync.
PUT /plans/{plan_id}/transactions/{transaction_id}	planned	Edit one transaction: memo, flag, payee, date or amount.
DELETE /plans/{plan_id}/transactions/{transaction_id}	covered	undo_operation
GET /user	excluded	The user’s id tells an agent nothing about the money.

By tool

What each tool and resource reads and writes, paths without the leading /plans/{plan_id}. A tool calls only what the case at hand needs: undo_operation the operations of the kind it undoes, get_spending_trends one month per month asked.

Tool or resource	Reads	Writes
find_recurring_charges	GET /categories, GET /scheduled_transactions, GET /transactions	—
find_transactions	GET /accounts, GET /categories, GET /transactions	—
forecast_balance	GET /accounts, GET /categories, GET /scheduled_transactions, GET /transactions	—
get_budget_vs_actual	GET /months/{month}	—
get_category_balances	GET /months/{month}	—
get_monthly_summary	GET /months/{month}	—
get_spending_trends	GET /months, GET /months/{month}	—
list_accounts	GET /accounts	—
list_category_groups	GET /categories	—
list_plans	GET /plans	—
list_scheduled_transactions	GET /accounts, GET /categories, GET /scheduled_transactions	—
suggest_categories	GET /accounts, GET /categories, GET /transactions	—
ynab://plans	GET /plans	—
ynab://plans/{plan_id}/accounts	GET /accounts	—
ynab://plans/{plan_id}/categories	GET /categories	—
apply_categories	GET /accounts, GET /categories, GET /transactions	PATCH /transactions
approve_transactions	—	PATCH /transactions
create_category	GET /categories	POST /categories
create_transactions	GET /accounts, GET /categories	POST /transactions
flag_transactions	GET /transactions	PATCH /transactions
import_transactions	—	POST /transactions/import
move_money	GET /months/{month}	PATCH /months/{month}/categories/{category_id}
reconcile_account	GET /accounts, GET /categories, GET /transactions	POST /transactions, PATCH /transactions
set_category_budget	GET /months/{month}	PATCH /months/{month}/categories/{category_id}
set_category_target	GET /categories	PATCH /categories/{category_id}
split_transaction	GET /accounts, GET /categories, GET /transactions	PATCH /transactions
undo_operation	GET /categories, GET /months/{month}, GET /transactions	PATCH /categories/{category_id}, PATCH /months/{month}/categories/{category_id}, PATCH /transactions, DELETE /transactions/{transaction_id}
update_category	GET /categories	PATCH /categories/{category_id}