Create a recurring invoice schedule
schedule_createDefine a repeating invoice: a client, the line items, how often to bill, and when it starts and ends. Returns the schedule id, a summary and its next dates. Nothing is invoiced until invoice_generate_due runs.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| every | Yes | How often to bill: "weekly", "monthly", "quarterly", "yearly", or {days: 10}. Month steps keep the start date's day of month and clamp it to shorter months, so a schedule starting on the 31st bills on the 28th/29th in February and back on the 31st in March | |
| items | Yes | The line items billed every period | |
| notes | No | Free text printed under the totals of every generated invoice | |
| client | Yes | Client name or id, as in the invoice server. Unknown names are created on the first generated invoice | |
| currency | No | Defaults to your business default currency | |
| due_days | No | Days until each invoice is due, defaults to your payment terms | |
| end_date | No | YYYY-MM-DD, INCLUSIVE: an occurrence landing exactly on it is still generated | |
| tax_note | No | Why this schedule bills the tax it bills, e.g. 'Reverse charge: VAT accounted for by the recipient, art. 196 Directive 2006/112/EC'. It is printed under the totals of EVERY invoice this schedule generates, so a 0% retainer carries its reason on the document instead of only in the chat | |
| anchor_day | No | Pro: bill on this day of month instead of the start date's day. 31 means the last day of every month | |
| start_date | Yes | YYYY-MM-DD. The first invoice falls on this date, and for weekly/monthly/quarterly/yearly steps its day of month is the billing day for every later period | |
| end_of_month | No | Pro: always bill on the last day of the month | |
| auto_generate | No | Marks the schedule for the monthly_billing_run prompt. Default false. Nothing runs in the background either way: invoices are created only when invoice_generate_due is called |