beel_patch_recurring_invoice
Partially update a recurring invoice template: change only the fields you send—lines, payment method, schedule, or recipient—while keeping all other settings intact.
Instructions
Updates only the fields present in the body, leaving every other field of the recurring invoice template as it is.
Omitted vs
null: an omitted field keeps its current value; a field sent asnullis cleared, and only where the request schema documents the field as nullable.lines: replaced as a whole, not patched line by line. The recipient survives the change, and an empty array is rejected.payment_method: replaced as a whole together withpayment_iban,payment_swiftandpayment_term_days— send them in the same request or they are dropped.Schedule:
day_of_monthandstart_datestay put unless you send them; sendingday_of_monthmoves the next generation.start_dateis only editable while the template has not generated any invoice yet.
Endpoint: PATCH /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}
⚠️ Fiscal guardrails — read before calling:
How BeeL derives the AEAT invoice type, and the rules each type imposes. (resource: beel://guardrails/invoice-types)
What regime_key means, where it lives, and which combinations are rejected. (resource: beel://guardrails/regime-keys)
For the exhaustive rules and worked examples, call beel_docs_search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| 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. | |
| recurring_invoice_id | Yes |