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

Returns the list of all numbering series configured in your account, grouped by document type.
Use this endpoint to discover available series before creating documents with a specific number_line_id.

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"

Request

import requests

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

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

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

Success responses

200 List of numbering series application/json object items[] 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

← PreviousUpdate a numbering series →

Next →Delete a numbering series →