Reference: Scheduled transactions

A scheduled transaction is a template for a recurring or future-dated transaction — rent due on the 1st, a subscription every month — with a next date and a frequency. These tools create, read, update, and delete the template itself; they don’t control whether YNAB has posted an occurrence of it yet — once one has been posted, it is an ordinary transaction in the Transactions toolset.

amount is in milliunits, negative for an outflow. Three of the five tools write, so the read-only default leaves only the two reads — see what read-only actually changes.

Tools

create_scheduled_transaction WRITE

Create a scheduled (recurring) transaction. amount is milliunits (negative = outflow).

**Milliunits:** `amount` — 1000 = one currency unit.

Parameters

Name	Type	Required	Description
budget_id	string		Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID.
account_id	string	✓
date	string	✓	ISO date of the first occurrence.
amount	number	✓	Milliunits; negative outflow, positive inflow.
frequency	enum: never | daily | weekly | everyOtherWeek | twiceAMonth | every4Weeks | monthly | everyOtherMonth | every3Months | every4Months | twiceAYear | yearly | everyOtherYear	✓
payee_id	string
payee_name	string
category_id	string
memo	string
flag_color	enum: red | orange | yellow | green | blue | purple

YNAB API

• POST /budgets/{budget_id}/scheduled_transactions → ScheduledTransactions/createScheduledTransaction

delete_scheduled_transaction WRITE

Delete a scheduled transaction by id.

Parameters

Name	Type	Required	Description
budget_id	string		Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID.
scheduled_transaction_id	string	✓

YNAB API

• DELETE /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} → ScheduledTransactions/deleteScheduledTransaction

get_scheduled_transaction READ

Get a single scheduled transaction by id.

Parameters

Name	Type	Required	Description
budget_id	string		Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID.
scheduled_transaction_id	string	✓

YNAB API

• GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} → ScheduledTransactions/getScheduledTransactionById

list_scheduled_transactions READ

List scheduled (recurring/upcoming) transactions with next date and frequency.

Parameters

Name	Type	Required	Description
budget_id	string		Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID.
last_knowledge_of_server	number

YNAB API

• GET /budgets/{budget_id}/scheduled_transactions → ScheduledTransactions/getScheduledTransactions

update_scheduled_transaction WRITE

Update fields on an existing scheduled transaction (only provided fields change).

**Milliunits:** `amount` — 1000 = one currency unit.

Parameters

Name	Type	Required	Description
budget_id	string		Budget id or alias (“last-used”, “default”). Defaults to YNAB_BUDGET_ID.
scheduled_transaction_id	string	✓
date	string
amount	number		Milliunits.
frequency	enum: never | daily | weekly | everyOtherWeek | twiceAMonth | every4Weeks | monthly | everyOtherMonth | every3Months | every4Months | twiceAYear | yearly | everyOtherYear
payee_id	string
payee_name	string
category_id	string
memo	string
flag_color	enum: red | orange | yellow | green | blue | purple

YNAB API

• PUT /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} → ScheduledTransactions/updateScheduledTransaction