beel_patch_series
Partially update an invoice series: only fields sent in the body change, the rest stay as-is. Use null to clear the description; numbering fields lock after invoices are issued.
Instructions
Updates only the fields present in the body, leaving every other field of the series as it is.
Clearing a field: a field sent as
nullis cleared, which onlydescriptionsupports.Numbering fields:
code,format,counter_resetandinitial_numberare rejected once the series has issued invoices (numbering_lockedistrue).default_series: it cannot be used to clear the default. Sendingfalsefor the series that currently is the default answersDEFAULT_CANNOT_BE_UNMARKED, because it would leave the document type with active series and no default, and issuing without an explicitseries_idwould then fail withSERIES_DEFAULT_NOT_FOUND. Hand the default over withPUT /v1/companies/{company_id}/series/{series_id}/defaulton the new series, which unmarks the previous one. Sendingfalsefor a series that is not the default is a no-op.
Endpoint: PATCH /v1/companies/{company_id}/series/{series_id}
⚠️ Fiscal guardrails — read before calling:
How invoice numbers are formed, and why numbering can never be rewritten. (resource: beel://guardrails/series-and-numbering)
For the exhaustive rules and worked examples, call beel_docs_search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| series_id | Yes | Series ID | |
| 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. |