PUT

Update a numbering series

Scope: sales:invoicing-settings.write https://api.alladdin.com/api/v2/numbering-series/{type}/{numberingSeriesId}

Updates an existing numbering series.
Omitting last leaves the counter unchanged. refund_numbering_series_id and verifactu_excluded are the exception: omit them and the refund series is unlinked, and an excluded series comes back into VeriFactu scope. Read the series first and send back every field you are not changing.
Changing the format does not affect previously issued document numbers — only new documents will use the updated format.

Parameters

Path parameters

type string required

Document type for the numbering series

"invoice" "salesreceipt" "creditnote" "estimate" "proform" "waybill" "salesorder" "purchase" "purchaserefund" "order" "purchaseshipment" "receiptnote" "productionorder" numberingSeriesId string required

Numbering series ID (24-char hex ObjectId)

Request body

object name string required

Name shown for this series in the invoicing settings.

format string required

Pattern the document number is built from. Each % is one digit of the counter, so the group length fixes the padding. [YYYY] and [YY] expand to the year. Changing it never renumbers documents already issued.

last integer optional

Last number already used in this series. The next document takes last + 1, so a series whose last invoice was INV-2026-1234 carries last: 1234, not 1235.

refund_numbering_series_id string | null optional

Id of the credit note series used for refunds of documents in this series. Null when no refund series is linked.

verifactu_excluded boolean optional

Whether documents in this series stay outside VeriFactu reporting.

Request

python

import requests

url = "https://api.alladdin.com/api/v2/numbering-series/{type}/{numberingSeriesId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "name": "Factura principal",
    "format": "INV-%[YYYY]-%",
    "last": 0,
    "refund_numbering_series_id": "string",
    "verifactu_excluded": false
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

Responses

Response

json

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Factura principal",
  "format": "INV-%[YYYY]-%",
  "last": 150,
  "type": "invoice",
  "refund_numbering_series_id": null,
  "verifactu_excluded": false
}

Success responses

200 Numbering series updated application/json object id string

Unique identifier of the numbering series

name string

Display name of the numbering series

format string

Numbering pattern with placeholders such as %[YYYY]% for year

last integer

Last number used in the series

type string

Document type this series applies to

refund_numbering_series_id string | null

Identifier of the linked refund numbering series, if any

verifactu_excluded boolean

Whether this series is excluded from VeriFactu reporting

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Numbering series not found application/json 422 Validation error application/json

← PreviousCreate a numbering series →

Next →List numbering series by document type →

Alladdin