Nummernkreise – API-Referenz

Nummernkreise auflisten

GET/api/v1/number-ranges

Alle Nummernkreise mit Muster und nächster Nummer. Nummern werden erst beim Festschreiben eines Belegs lückenlos vergeben.

Berechtigung: profile:read

Antwort 200

dataArray<NumberRange>Pflicht
- kindenumPflicht
  Belegart
  Werte: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
- labelstringPflicht
- patternstringPflicht
  Muster, z. B. RE-{YYYY}-{0000}
- nextstringPflicht
  Vorschau der nächsten Nummer (heute)

Mögliche Fehler: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/number-ranges' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "data": [
    {
      "kind": "invoice",
      "label": "string",
      "pattern": "string",
      "next": "string"
    }
  ]
}

Nummernkreis abrufen

GET/api/v1/number-ranges/{kind}

Berechtigung: profile:read

Pfadparameter

kindenumPflicht
Belegart
Werte: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project

Antwort 200 · NumberRange

kindenumPflicht
Belegart
Werte: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
labelstringPflicht
patternstringPflicht
Muster, z. B. RE-{YYYY}-{0000}
nextstringPflicht
Vorschau der nächsten Nummer (heute)

Mögliche Fehler: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/number-ranges/KIND' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "kind": "invoice",
  "label": "string",
  "pattern": "string",
  "next": "string"
}

Nummernkreis anpassen

PATCH/api/v1/number-ranges/{kind}

Muster ändern und/oder Startnummer setzen, z. B. zur Fortführung aus einem anderen Programm. Die Startnummer gilt für den aktuellen Zeitraum und nur, solange dort noch keine Nummer vergeben wurde.

Berechtigung: profile:write

Pfadparameter

kindenumPflicht
Belegart
Werte: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project

Body (JSON) · NumberRangeUpdate

patternstring
Platzhalter {YYYY} {YY} {MM} {DD} und genau ein Zähler wie {0000}
max. 40 Zeichen
startAtinteger
Startnummer im aktuellen Zeitraum
1–99999999

Antwort 200 · NumberRange

kindenumPflicht
Belegart
Werte: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
labelstringPflicht
patternstringPflicht
Muster, z. B. RE-{YYYY}-{0000}
nextstringPflicht
Vorschau der nächsten Nummer (heute)

Mögliche Fehler: 400, 401, 403, 404, 409, 429, 500

curl -X PATCH 'https://www.debt-flow.io/api/v1/number-ranges/KIND' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "pattern": "string",
  "startAt": 1
}'

Antwort 200

{
  "kind": "invoice",
  "label": "string",
  "pattern": "string",
  "next": "string"
}