Zum Inhalt springen
DebtFlow

Number ranges

Number ranges for documents, customers and projects.

List number ranges

GET/api/v1/number-ranges

All number ranges with their pattern and next number. Numbers are assigned without gaps, and only when a document is finalised.

Permission: profile:read

Response 200

  • dataArray<NumberRange>required
    • kindenumrequired
      Document type
      Values: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
    • labelstringrequired
    • patternstringrequired
      Pattern, e.g. RE-{YYYY}-{0000}
    • nextstringrequired
      Preview of the next number (today)

Possible errors: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/number-ranges' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "data": [
    {
      "kind": "invoice",
      "label": "string",
      "pattern": "string",
      "next": "string"
    }
  ]
}

Retrieve number range

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

Permission: profile:read

Path parameters

  • kindenumrequired
    Document type
    Values: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project

Response 200 · NumberRange

  • kindenumrequired
    Document type
    Values: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
  • labelstringrequired
  • patternstringrequired
    Pattern, e.g. RE-{YYYY}-{0000}
  • nextstringrequired
    Preview of the next number (today)

Possible errors: 400, 401, 403, 404, 429, 500

curl 'https://www.debt-flow.io/api/v1/number-ranges/KIND' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"
Response 200
{
  "kind": "invoice",
  "label": "string",
  "pattern": "string",
  "next": "string"
}

Adjust number range

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

Change the pattern and/or set the start number, e.g. to continue numbering from another program. The start number applies to the current period and only as long as no number has been assigned in it yet.

Permission: profile:write

Path parameters

  • kindenumrequired
    Document type
    Values: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project

Body (JSON) · NumberRangeUpdate

  • patternstring
    Placeholders {YYYY} {YY} {MM} {DD} and exactly one counter such as {0000}
    max. 40 characters
  • startAtinteger
    Starting number in the current period
    1–99999999

Response 200 · NumberRange

  • kindenumrequired
    Document type
    Values: invoice, credit_note, offer, order_confirmation, delivery_note, receipt, customer, supplier, project
  • labelstringrequired
  • patternstringrequired
    Pattern, e.g. RE-{YYYY}-{0000}
  • nextstringrequired
    Preview of the next number (today)

Possible errors: 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
}'
Response 200
{
  "kind": "invoice",
  "label": "string",
  "pattern": "string",
  "next": "string"
}