Mandanten – API-Referenz

Mandanten auflisten

GET/api/v1/clients

Für Inkassounternehmen und Kanzleien: Auftraggeber, in deren Namen Forderungen eingezogen werden. Alphabetisch.

Berechtigung: clients:read

Query-Parameter

limitinteger
Anzahl Einträge (1–100)
1–100 · Standard: 25
cursorstring
`nextCursor` der vorherigen Seite
max. 500 Zeichen

Antwort 200

object"list"Pflicht
dataArray<Client>Pflicht
- idstringPflicht
- object"client"Pflicht
- namestringPflicht
- legalFormstringPflicht
- representedBystringPflicht
- clientNumberstringPflicht
- streetstringPflicht
- zipCodestringPflicht
- citystringPflicht
- countrystringPflicht
- emailstringPflicht
- phonestringPflicht
- ibanstringPflicht
- bicstringPflicht
- bankNamestringPflicht
- vatDeductiblebooleanPflicht
  Vorsteuerabzugsberechtigt
- notesstringPflicht
- debtCountintegerPflicht
  -9007199254740991–9007199254740991
- openDebtCountintegerPflicht
  -9007199254740991–9007199254740991
- 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/clients' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "client",
      "name": "string",
      "legalForm": "string",
      "representedBy": "string",
      "clientNumber": "string",
      "street": "string",
      "zipCode": "string",
      "city": "string",
      "country": "string",
      "email": "string",
      "phone": "string",
      "iban": "string",
      "bic": "string",
      "bankName": "string",
      "vatDeductible": false,
      "notes": "string",
      "debtCount": 0,
      "openDebtCount": 0,
      "createdAt": "2026-11-01T09:30:00.000Z",
      "updatedAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Mandant anlegen

POST/api/v1/clients

Berechtigung: clients: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) · ClientCreate

namestringPflicht
max. 200 Zeichen
legalFormstring
max. 60 Zeichen
representedBystring
max. 200 Zeichen
clientNumberstring
max. 60 Zeichen
streetstring
max. 160 Zeichen
zipCodestring
max. 10 Zeichen
citystring
max. 80 Zeichen
countrystring
max. 60 Zeichen
emailstring (email) | ""
phonestring
max. 40 Zeichen
ibanstring
max. 42 Zeichen
bicstring
max. 11 Zeichen
bankNamestring
max. 80 Zeichen
vatDeductibleboolean
notesstring
max. 5000 Zeichen

Antwort 201 · Client

idstringPflicht
object"client"Pflicht
namestringPflicht
legalFormstringPflicht
representedBystringPflicht
clientNumberstringPflicht
streetstringPflicht
zipCodestringPflicht
citystringPflicht
countrystringPflicht
emailstringPflicht
phonestringPflicht
ibanstringPflicht
bicstringPflicht
bankNamestringPflicht
vatDeductiblebooleanPflicht
Vorsteuerabzugsberechtigt
notesstringPflicht
debtCountintegerPflicht
-9007199254740991–9007199254740991
openDebtCountintegerPflicht
-9007199254740991–9007199254740991
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/clients' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "legalForm": "string",
  "representedBy": "string",
  "clientNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "email": "[email protected]",
  "phone": "string",
  "iban": "string",
  "bic": "string",
  "bankName": "string",
  "vatDeductible": false,
  "notes": "string"
}'

Antwort 201

{
  "id": "string",
  "object": "client",
  "name": "string",
  "legalForm": "string",
  "representedBy": "string",
  "clientNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "email": "string",
  "phone": "string",
  "iban": "string",
  "bic": "string",
  "bankName": "string",
  "vatDeductible": false,
  "notes": "string",
  "debtCount": 0,
  "openDebtCount": 0,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Mandant abrufen

GET/api/v1/clients/{id}

Forderungen des Mandanten: GET /debts?clientId=….

Berechtigung: clients:read

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Antwort 200 · Client

idstringPflicht
object"client"Pflicht
namestringPflicht
legalFormstringPflicht
representedBystringPflicht
clientNumberstringPflicht
streetstringPflicht
zipCodestringPflicht
citystringPflicht
countrystringPflicht
emailstringPflicht
phonestringPflicht
ibanstringPflicht
bicstringPflicht
bankNamestringPflicht
vatDeductiblebooleanPflicht
Vorsteuerabzugsberechtigt
notesstringPflicht
debtCountintegerPflicht
-9007199254740991–9007199254740991
openDebtCountintegerPflicht
-9007199254740991–9007199254740991
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/clients/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "id": "string",
  "object": "client",
  "name": "string",
  "legalForm": "string",
  "representedBy": "string",
  "clientNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "email": "string",
  "phone": "string",
  "iban": "string",
  "bic": "string",
  "bankName": "string",
  "vatDeductible": false,
  "notes": "string",
  "debtCount": 0,
  "openDebtCount": 0,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Mandant ändern

PATCH/api/v1/clients/{id}

Berechtigung: clients:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Body (JSON) · ClientUpdate

namestring
max. 200 Zeichen
legalFormstring
max. 60 Zeichen
representedBystring
max. 200 Zeichen
clientNumberstring
max. 60 Zeichen
streetstring
max. 160 Zeichen
zipCodestring
max. 10 Zeichen
citystring
max. 80 Zeichen
countrystring
max. 60 Zeichen
emailstring (email) | ""
phonestring
max. 40 Zeichen
ibanstring
max. 42 Zeichen
bicstring
max. 11 Zeichen
bankNamestring
max. 80 Zeichen
vatDeductibleboolean
notesstring
max. 5000 Zeichen

Antwort 200 · Client

idstringPflicht
object"client"Pflicht
namestringPflicht
legalFormstringPflicht
representedBystringPflicht
clientNumberstringPflicht
streetstringPflicht
zipCodestringPflicht
citystringPflicht
countrystringPflicht
emailstringPflicht
phonestringPflicht
ibanstringPflicht
bicstringPflicht
bankNamestringPflicht
vatDeductiblebooleanPflicht
Vorsteuerabzugsberechtigt
notesstringPflicht
debtCountintegerPflicht
-9007199254740991–9007199254740991
openDebtCountintegerPflicht
-9007199254740991–9007199254740991
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/clients/ID' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "legalForm": "string",
  "representedBy": "string",
  "clientNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "email": "[email protected]",
  "phone": "string",
  "iban": "string",
  "bic": "string",
  "bankName": "string",
  "vatDeductible": false,
  "notes": "string"
}'

Antwort 200

{
  "id": "string",
  "object": "client",
  "name": "string",
  "legalForm": "string",
  "representedBy": "string",
  "clientNumber": "string",
  "street": "string",
  "zipCode": "string",
  "city": "string",
  "country": "string",
  "email": "string",
  "phone": "string",
  "iban": "string",
  "bic": "string",
  "bankName": "string",
  "vatDeductible": false,
  "notes": "string",
  "debtCount": 0,
  "openDebtCount": 0,
  "createdAt": "2026-11-01T09:30:00.000Z",
  "updatedAt": "2026-11-01T09:30:00.000Z"
}

Mandant löschen

DELETE/api/v1/clients/{id}

Nur ohne zugeordnete Forderungen möglich (sonst 409 in_use).

Berechtigung: clients:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Antwort 204

Erfolg, keine Antwort

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

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