Assign more money to a category from Ready to Assign, or take some back.

This adds to what is already assigned: assigning 100 to a category with 250 assigned leaves 350 assigned. A negative amount returns money to Ready to Assign. Calling this twice assigns twice, so do not retry it blindly after an error; check the category with get_month_category first.

For categories with NEED targets that refill each month, the full target is usually assigned every month, whatever is available.

Create an account that the user tracks by hand, such as cash or a new savings account. The account is not connected to a bank.

Create a category in a category group, optionally with a target.

Create an empty category group.

Create a payee.

A new transaction can also create its payee by giving payee_name, so this is only needed to set up a payee before any transaction uses it.

Schedule a transaction: a bill, a paycheck, or a regular transfer.

Create one or more transactions in one request.

Use this to enter spending from a receipt, record income, enter a transfer between accounts, or add a split transaction. Calling this twice enters the transactions twice.

Example entries:

• Spending: account_id=, date=2024-03-02, amount=-43.17, payee_name="Kroger", category_id=

• Income: amount=2500, payee_name="Acme Payroll", category_id=<Inflow: Ready to Assign>

• Transfer: account_id=, amount=-200, transfer_account_id=, no category

• Split: amount=-80, payee_name="Target", no category, splits=[ {amount: -50, category_id: }, {amount: -30, category_id: }]

Delete a scheduled transaction, so it stops happening. Transactions it already entered stay. Confirm with the user before deleting.

Delete a transaction. Confirm with the user before deleting.

Enter a scheduled transaction now, before its date, like YNAB's "Enter Now". Use this when a bill is paid early or a paycheck arrives early.

This creates the transaction and moves the schedule to the occurrence after its next one. A schedule that happens only once is deleted. Split scheduled transactions, and those that repeat "twiceAMonth", cannot be entered this way; enter them in YNAB. Calling this twice enters two occurrences.

Find payees whose names contain a search term, ignoring case.

Example queries this tool can answer:

• "Find Amazon payee ID" (use name_search="amazon")

• "Show me all Starbucks locations" (use name_search="starbucks")

• "Find payees with 'grocery' in the name" (use name_search="grocery")

Get one category's assigned, activity, available, and target for a month.

Get the plan's name, the months it covers, and its currency and date formats. Use the currency format to write amounts the way the user sees them in YNAB.

Get one month of the plan: income, assigned, activity, Ready to Assign, age of money, and each visible category's amounts for that month.

Get one scheduled transaction.

Get one transaction, including the parts of a split.

Ask YNAB to import new transactions from the plan's linked bank accounts now, instead of waiting for its next scheduled import.

Imported transactions arrive unapproved. Find them with list_transactions and status="unapproved".

List the plan's accounts with their balances.

Each account includes its transfer_payee_id: use it as the payee of a transaction to transfer money into that account.

List the plan's categories with this month's amounts and targets.

Only returns visible categories. Hidden and deleted categories are excluded. Categories come in the order the plan shows them, group by group.

List the plan's category groups with this month's totals.

Lighter than list_categories when only the overview by group is needed.

List the history of money assigned and moved between categories.

Use this to explain why a category's assigned amount changed: each entry says how much moved, from where, to where, and when.

List the plan's payees, sorted by name.

Payees are the people and businesses money goes to and comes from. To find a particular payee, find_payee is much faster than paging through this list. Deleted payees are excluded.

List the plan's months with their totals, newest first.

Use this for trends over time: income, assigned, and activity by month, how Ready to Assign changed, and how age of money moved.

List scheduled transactions, soonest first, with filters that can be combined.

Example queries this tool can answer:

• "Show me all monthly recurring expenses" (use frequency="monthly")

• "What bills are due in the next 7 days?" (use upcoming_days=7)

• "List all Netflix subscriptions" (find the payee first, then use payee_id)

• "Show scheduled income over $100" (use min_amount=100)

List transactions, newest first, with filters that can be combined.

Example queries this tool can answer:

• "Show me all transactions over $50 in Dining Out this year" → category_id=, max_amount=-50, since_date=2024-01-01

• "What do I still need to review?" → status="unapproved"

• "What hasn't been categorized?" → status="uncategorized"

• "How much did we spend at Amazon in March?" → payee_id=, since_date=2024-03-01, until_date=2024-03-31

• "Find the soccer registration fee" → text_search="soccer"

Filtering by category or payee returns each part of a split transaction as its own row, with parent_transaction_id set.

Move assigned money from one category to another within a month.

This is how to cover overspending or reallocate: it takes the amount off one category's assigned amount and adds it to the other's. Ready to Assign does not change. If YNAB rejects the second change, the first is put back before the error is reported.

Rename a category group.

Rename a payee. Every transaction with this payee shows the new name.

Set exactly how much is assigned to a category in a month.

Unlike assign_money, this replaces the assigned amount, so it is safe to retry. Ready to Assign absorbs the difference.

Rename a category, change its note, move it to another group, or set its target. Only the fields given change.

To change what is assigned to a category, use assign_money or set_assigned.

Change a scheduled transaction. Fields left out do not change.

Use this when a bill's amount changes, it moves to another day or account, or it repeats on a new schedule. Split scheduled transactions cannot be changed through YNAB's API.

Change one or more existing transactions in one request.

Each change names a transaction and only the fields to change; every other field stays as it is. This is the tool for reviewing transactions: approve them, categorize them, fix payees, set memos, flag them, or mark them cleared.

Example changes:

• Approve and categorize: {id: , approved: true, category_id: }

• Fix the payee: {id: , payee_name: "Costco"}

• Clear the memo and the flag: {id: , memo: "", clear_flag: true}