get_recurring_templates
Read recurring invoice templates to inspect their schedules, execution status, and draft finalization behavior, or fetch a single template by ID for full line and tax details.
Instructions
Read the templates that issue invoices on a schedule.
One API call. With template_id it answers with that one template,
without it with a page of them.
A row is shorter than the record behind it: what a template will actually invoice, its lines and tax, is only in the record, so read by id to see that.
recurringTemplateSettings carries the schedule. executionStatus
says whether it still runs, and finalize false means each run leaves
a draft rather than issuing an invoice.
There is nothing to filter by, and reading is all the API allows.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_recurring_templates"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Zero-based page number. Read the `page` block of the previous result before asking for another one, rather than paging blindly. | |
| size | No | Rows per page. A larger page costs the same single API call but more of the answer's token budget, so raise it only when the whole list is genuinely needed. | |
| sort | No | Which date to order by, newest first unless ',ASC' is added. The API sorts on these four and nothing else. | |
| template_id | No | Read one template by id. Left unset, a page of them comes back instead. |