beel_generate_recurring_invoice_now
Generate a recurring invoice now, outside its schedule, by consuming the pending occurrence and advancing the template's next generation date.
Instructions
Runs the generation of this recurring template immediately, out of its schedule. It is a fiscal act: the generated invoice consumes numbering from the series of the template and, when the template says so, is issued and sent.
It brings the upcoming occurrence forward, it does not add one: the call consumes the period that was pending, so the invoice is created now and
next_generationadvances one period. Generating manually, skipping and letting the schedule run each consume exactly one occurrence, so a monthly template still produces twelve invoices a year however you mix the three.next_generationin the response: the template's next date after this call consumed the pending occurrence, ornullwhen the advance took the template past itsend_dateand its status is nowCOMPLETED.An extra invoice outside the calendar: do not use this endpoint. Create a normal invoice, or derive a draft from one the template already generated with
POST /v1/companies/{company_id}/invoices/derivations. Either way the schedule stays where it was.
Endpoint: POST /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/generate
⚠️ Read before calling:
Fiscal rules, domains simplified, taxes: beel_rules_list with domain, or resource beel://guardrails/.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed. | |
| idempotency_key | No | Optional idempotency key for this operation. Omit it and one is derived from the request itself, which makes a blind retry safe but also collapses a SECOND, deliberately identical operation into the first for 24 hours. Set it — to an order id, or anything unique per intended operation — whenever you mean to create something that may look identical to what you just created. | |
| recurring_invoice_id | Yes | Unique identifier (UUID) of the recurring invoice template, as returned when it is created or listed. A template of another company answers `404` with `RECURRING_NOT_FOUND`, exactly like one that does not exist. |