Saltar al contingut principal
PUT

Actualitzar una sèrie de numeració

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

Actualitza una sèrie de numeració existent. **Això reemplaça la sèrie sencera.** Cada camp que la petició omet torna al seu valor per defecte, així que una petició sense `last` deixa el comptador a 0 i el document següent torna a començar a 1. El mateix amb `refund_numbering_series_id` i `verifactu_excluded`. Llegeix la sèrie abans i retorna tots els camps que no vulguis canviar.

Paràmetres

Paràmetres de ruta

typestringobligatori

Tipus de recurs

"invoice""salesreceipt""creditnote""estimate""proform""waybill""salesorder""purchase""purchaserefund""order""purchaseshipment""receiptnote""productionorder"
numberingSeriesIdstringobligatori

ID de la sèrie de numeració (ObjectId hexadecimal de 24 caràcters)

Cos de la petició

object
namestringrequired

Nom amb què es veu la sèrie als ajustos de facturació

formatstringrequired

Patró amb què es construeix el número. Cada `%` és un dígit del comptador, així que la longitud del grup fixa l'ompliment. `[YYYY]` i `[YY]` se substitueixen per l'any. Canviar-lo no renumera els documents ja emesos

lastintegeroptional

Darrer número ja utilitzat en aquesta sèrie. El document següent pren `last + 1`, així que una sèrie amb darrera factura INV-2026-1234 porta `last: 1234`, no 1235

refund_numbering_series_idstring | nulloptional

Identificador de la sèrie de rectificatives usada per als abonaments d'aquesta sèrie. Nul quan no n'hi ha cap de vinculada

verifactu_excludedbooleanoptional

Si els documents d'aquesta sèrie queden fora de l'àmbit de Verifactu

Petició

python
import requests

url = "https://api.holded.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())

Respostes

Resposta

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

Respostes exitoses

200Sèrie de numeració actualitzadaapplication/json
object
idstring

Unique identifier of the numbering series

namestring

Display name of the numbering series

formatstring

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

lastinteger

Last number used in the series

typestring

Document type this series applies to

refund_numbering_series_idstring | null

Identifier of the linked refund numbering series, if any

verifactu_excludedboolean

Whether this series is excluded from VeriFactu reporting

Respostes d'error

400Sol·licitud incorrectaapplication/json
401API key no vàlida o no proporcionadaapplication/json
403Permisos insuficientsapplication/json
404Sèrie de numeració no trobadaapplication/json
422Error de validacióapplication/json