update_scheduled_transaction
Update a scheduled transaction in YNAB by specifying account and future date, with optional changes to amount, payee, category, memo, flag color, or frequency.
Instructions
Update a scheduled transaction.
The API requires account_id and date on every update. Splits are not supported on this endpoint. Date must be in the future, no more than 5 years out.
Args: plan_id: The plan ID (use list_plans to find available IDs) scheduled_transaction_id: The scheduled transaction ID to update account_id: The account ID for this scheduled transaction (required) date: Future date in YYYY-MM-DD format (required, no more than 5 years out) amount: Amount in dollars (negative for outflow, positive for inflow) payee_id: Payee ID. For account transfers, use the target account's transfer_payee_id. payee_name: Payee name (resolves to existing or creates a new payee) category_id: Category ID. Credit Card Payment categories are not permitted. memo: Memo/note (max 500 chars) flag_color: 'red', 'orange', 'yellow', 'green', 'blue', 'purple', or null frequency: One of 'never', 'daily', 'weekly', 'everyOtherWeek', 'twiceAMonth', 'every4Weeks', 'monthly', 'everyOtherMonth', 'every3Months', 'every4Months', 'twiceAYear', 'yearly', 'everyOtherYear' exclude_fields: Optional list of field names to exclude from the response. If omitted, the model's default exclude list is used (see FIELDS.md). Pass [] to return all fields. Pass a custom list to override the default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | ||
| memo | No | ||
| amount | No | ||
| plan_id | Yes | ||
| payee_id | No | ||
| frequency | No | ||
| account_id | Yes | ||
| flag_color | No | ||
| payee_name | No | ||
| category_id | No | ||
| exclude_fields | No | ||
| scheduled_transaction_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |