Create scheduled transaction
create_scheduled_transactionCreate recurring or one-time YNAB transactions for bills, paychecks, or transfers by setting account, amount, date, and frequency.
Instructions
Schedule a transaction: a bill, a paycheck, or a regular transfer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | First date it happens: in the future, at most 5 years out (required) | |
| memo | No | Memo, at most 500 characters (optional) | |
| amount | Yes | Amount in currency units: negative for spending, positive for income (required) | |
| payee_id | No | Payee, by ID (optional) | |
| frequency | Yes | How often it repeats, or "never" for once (required) | |
| account_id | Yes | Account it happens in (required) | |
| flag_color | No | Flag color (optional) | |
| payee_name | No | Payee by name, when payee_id is not given. YNAB uses the payee with this name, or creates it (optional) | |
| category_id | No | Category. Credit card payment categories are not allowed (optional) | |
| transfer_account_id | No | For a transfer, the other account. Use instead of a payee (optional) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique scheduled transaction identifier | |
| flag | No | Flag as 'Name (Color)' format | |
| memo | No | User-entered memo | |
| amount | Yes | Amount in currency units (negative = spending, positive = income) | |
| payee_id | No | Payee ID | |
| date_next | Yes | Next occurrence date | |
| frequency | Yes | How often it happens | |
| account_id | Yes | Account ID | |
| date_first | Yes | First occurrence date | |
| payee_name | No | Payee name | |
| category_id | No | Category ID | |
| account_name | No | Account name | |
| category_name | No | Category name | |
| subtransactions | No | The parts of a split scheduled transaction | |
| transfer_account_id | No | For a transfer, the other account |