Artikel – API-Referenz

Artikel und Leistungen auflisten

GET/api/v1/articles

Alphabetisch nach Bezeichnung.

Berechtigung: articles:read

Query-Parameter

archived"true" | "false"
true = nur archivierte, false = nur aktive (Standard: alle)
limitinteger
Anzahl Einträge (1–100)
1–100 · Standard: 25
cursorstring
`nextCursor` der vorherigen Seite
max. 500 Zeichen

Antwort 200

object"list"Pflicht
dataArray<Article>Pflicht
- idstringPflicht
  max. 128 Zeichen
- object"article"Pflicht
- numberstring | nullPflicht
- titlestringPflicht
- descriptionstring | nullPflicht
- unitstring | nullPflicht
- unitPriceCentsintegerPflicht
  Betrag in Cent
  -100000000000–100000000000
- priceMode"net" | "gross"Pflicht
- taxRatenumberPflicht
- archivedbooleanPflicht
- createdAtstring (date-time)Pflicht
  Zeitpunkt (ISO 8601)
- updatedAtstring (date-time)Pflicht
  Zeitpunkt (ISO 8601)
hasMorebooleanPflicht
nextCursorstring | nullPflicht

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

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

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "article",
      "number": "string",
      "title": "string",
      "description": "string",
      "unit": "string",
      "unitPriceCents": 0,
      "priceMode": "net",
      "taxRate": 0,
      "archived": false,
      "createdAt": "2026-11-01T09:30:00.000Z",
      "updatedAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Artikel anlegen

POST/api/v1/articles

Berechtigung: articles:write

Header

Idempotency-Keystring
Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
max. 255 Zeichen

Body (JSON) · ArticleCreate

numberstring
Artikelnummer (frei)
max. 40 Zeichen
titlestringPflicht
max. 300 Zeichen
descriptionstring
max. 5000 Zeichen
unitstring
max. 20 Zeichen
unitPriceCentsinteger
Betrag in Cent
-100000000000–100000000000 · Standard: 0
priceMode"net" | "gross"
Standard: "net"
taxRatenumber
Steuersatz in Prozent (19, 7, 0 …)
0–100 · Standard: 19
archivedboolean

Antwort 201 · Article

idstringPflicht
max. 128 Zeichen
object"article"Pflicht
numberstring | nullPflicht
titlestringPflicht
descriptionstring | nullPflicht
unitstring | nullPflicht
unitPriceCentsintegerPflicht
Betrag in Cent
-100000000000–100000000000
priceMode"net" | "gross"Pflicht
taxRatenumberPflicht
archivedbooleanPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)
updatedAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

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

curl -X POST 'https://www.debt-flow.io/api/v1/articles' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 19,
  "archived": false
}'

Antwort 201

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Artikel abrufen

GET/api/v1/articles/{id}

Berechtigung: articles:read

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Antwort 200 · Article

idstringPflicht
max. 128 Zeichen
object"article"Pflicht
numberstring | nullPflicht
titlestringPflicht
descriptionstring | nullPflicht
unitstring | nullPflicht
unitPriceCentsintegerPflicht
Betrag in Cent
-100000000000–100000000000
priceMode"net" | "gross"Pflicht
taxRatenumberPflicht
archivedbooleanPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)
updatedAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

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

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

Antwort 200

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Artikel ändern

PATCH/api/v1/articles/{id}

Bestehende Rechnungen und Angebote behalten ihre Positionen (Kopie).

Berechtigung: articles:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Body (JSON) · ArticleUpdate

numberstring
Artikelnummer (frei)
max. 40 Zeichen
titlestring
max. 300 Zeichen
descriptionstring
max. 5000 Zeichen
unitstring
max. 20 Zeichen
unitPriceCentsinteger
Betrag in Cent
-100000000000–100000000000
priceMode"net" | "gross"
taxRatenumber
Steuersatz in Prozent (19, 7, 0 …)
0–100
archivedboolean

Antwort 200 · Article

idstringPflicht
max. 128 Zeichen
object"article"Pflicht
numberstring | nullPflicht
titlestringPflicht
descriptionstring | nullPflicht
unitstring | nullPflicht
unitPriceCentsintegerPflicht
Betrag in Cent
-100000000000–100000000000
priceMode"net" | "gross"Pflicht
taxRatenumberPflicht
archivedbooleanPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)
updatedAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

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

curl -X PATCH 'https://www.debt-flow.io/api/v1/articles/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false
}'

Antwort 200

{
  "id": "string",
  "object": "article",
  "number": "string",
  "title": "string",
  "description": "string",
  "unit": "string",
  "unitPriceCents": 0,
  "priceMode": "net",
  "taxRate": 0,
  "archived": false,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Artikel löschen

DELETE/api/v1/articles/{id}

Alternativ archived: true setzen, um den Artikel nur auszublenden.

Berechtigung: articles:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Antwort 204

Erfolg, keine Antwort

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

curl -X DELETE 'https://www.debt-flow.io/api/v1/articles/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"