create_scheduled_transaction
Create a recurring transaction template for GnuCash to set up automatic postings. Define splits, frequency, start date, and optional end date or notes.
Instructions
Create a recurring transaction template.
Args:
name: Scheduled transaction name (e.g., "Monthly Rent").
description: Transaction description at instantiation.
splits: Same format as create_transaction, e.g.
[{"account": "Expenses:Rent", "amount": "1850.00"}, ...].
amount / quantity must be decimal strings;
quantity is required when an account's commodity
differs from the template's transaction currency.
start_date: First occurrence (YYYY-MM-DD).
frequency: "weekly", "biweekly" (2w), "monthly",
"bimonthly" (2mo), "quarterly" (3mo), or "yearly".
end_date: Optional last occurrence (YYYY-MM-DD).
enabled: Active. Default True.
notes: Transaction notes applied to every instantiated
transaction (what the payment is — visible in
GnuCash's double-line register view).
currency: ISO code denominating every instantiated
transaction; defaults to the book default. Use when
no leg is in the book currency (a USD-to-USD card
payment scheduled inside a CNY book) so amounts are
the foreign currency's own numbers. Not updatable
after creation — delete and recreate to change it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| notes | No | ||
| splits | Yes | ||
| enabled | No | ||
| currency | No | ||
| end_date | No | ||
| frequency | Yes | ||
| start_date | Yes | ||
| description | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |