Konto – API-Referenz

Firmen- und Rechnungsstammdaten abrufen

GET/api/v1/company-profile

Absender, Steuernummer/USt-IdNr., Kleinunternehmer-Status, Bankverbindung, Logo und Rechnungs-Fußzeile. missing nennt fehlende Pflichtangaben.

Berechtigung: profile:read

Antwort 200 · CompanyProfile

companyNamestringPflicht
Firma bzw. Name des Unternehmers (erscheint als Absender)
ownerNamestringPflicht
Inhaber/in (bei Einzelunternehmen)
legalFormstringPflicht
managingDirectorsstringPflicht
Geschäftsführung/Vorstand (Pflicht bei Kapitalgesellschaften)
addressobjectPflicht
- streetstringPflicht
- zipCodestringPflicht
- citystringPflicht
- countryCodestringPflicht
phonestringPflicht
emailstringPflicht
websitestringPflicht
taxNumberstringPflicht
Steuernummer des Finanzamts
vatIdstringPflicht
Umsatzsteuer-Identifikationsnummer
smallBusinessbooleanPflicht
Kleinunternehmer nach § 19 UStG (keine Umsatzsteuer ausweisen)
commercialRegisterobjectPflicht
- courtstringPflicht
- numberstringPflicht
bankobjectPflicht
- accountHolderstringPflicht
- ibanstringPflicht
- bicstringPflicht
- bankNamestringPflicht
logoCompanyLogo | nullPflicht
- contentType"image/png" | "image/jpeg"Pflicht
- sizeintegerPflicht
  -9007199254740991–9007199254740991
- updatedAtstringPflicht
invoiceFooterstringPflicht
Eigene Fußzeile auf Rechnungen
paymentTermsDaysintegerPflicht
Standard-Zahlungsziel in Tagen
-9007199254740991–9007199254740991
completebooleanPflicht
Pflichtangaben für Rechnungen (§ 14 UStG) vollständig
missingArray<string>Pflicht
Fehlende Angaben (Klartext)

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

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

Antwort 200

{
  "companyName": "string",
  "ownerName": "string",
  "legalForm": "string",
  "managingDirectors": "string",
  "address": {
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "string",
  "website": "string",
  "taxNumber": "string",
  "vatId": "string",
  "smallBusiness": false,
  "commercialRegister": {
    "court": "string",
    "number": "string"
  },
  "bank": {
    "accountHolder": "string",
    "iban": "string",
    "bic": "string",
    "bankName": "string"
  },
  "logo": {
    "contentType": "image/png",
    "size": 0,
    "updatedAt": "string"
  },
  "invoiceFooter": "string",
  "paymentTermsDays": 0,
  "complete": false,
  "missing": [
    "string"
  ]
}

Firmen- und Rechnungsstammdaten ändern

PATCH/api/v1/company-profile

Nur übergebene Felder werden geändert. Leere Zeichenkette löscht einen Wert. Änderungen werden protokolliert; bereits festgeschriebene Belege behalten ihre Angaben.

Berechtigung: profile:write

Body (JSON) · CompanyProfileUpdate

companyNamestring
max. 160 Zeichen
ownerNamestring
max. 120 Zeichen
legalFormenum | ""
managingDirectorsstring
max. 300 Zeichen
addressobject
- streetstring
  max. 160 Zeichen
- zipCodestring
  max. 10 Zeichen
- citystring
  max. 80 Zeichen
- countryCodestring
phonestring
max. 40 Zeichen
emailstring (email) | ""
websitestring
max. 200 Zeichen
taxNumberstring
max. 20 Zeichen
vatIdstring
smallBusinessboolean
commercialRegisterobject
- courtstring
  max. 120 Zeichen
- numberstring
  max. 60 Zeichen
bankobject
- accountHolderstring
  max. 120 Zeichen
- ibanstring
- bicstring
- bankNamestring
  max. 80 Zeichen
invoiceFooterstring
max. 1000 Zeichen
paymentTermsDaysinteger
0–365

Antwort 200 · CompanyProfile

companyNamestringPflicht
Firma bzw. Name des Unternehmers (erscheint als Absender)
ownerNamestringPflicht
Inhaber/in (bei Einzelunternehmen)
legalFormstringPflicht
managingDirectorsstringPflicht
Geschäftsführung/Vorstand (Pflicht bei Kapitalgesellschaften)
addressobjectPflicht
- streetstringPflicht
- zipCodestringPflicht
- citystringPflicht
- countryCodestringPflicht
phonestringPflicht
emailstringPflicht
websitestringPflicht
taxNumberstringPflicht
Steuernummer des Finanzamts
vatIdstringPflicht
Umsatzsteuer-Identifikationsnummer
smallBusinessbooleanPflicht
Kleinunternehmer nach § 19 UStG (keine Umsatzsteuer ausweisen)
commercialRegisterobjectPflicht
- courtstringPflicht
- numberstringPflicht
bankobjectPflicht
- accountHolderstringPflicht
- ibanstringPflicht
- bicstringPflicht
- bankNamestringPflicht
logoCompanyLogo | nullPflicht
- contentType"image/png" | "image/jpeg"Pflicht
- sizeintegerPflicht
  -9007199254740991–9007199254740991
- updatedAtstringPflicht
invoiceFooterstringPflicht
Eigene Fußzeile auf Rechnungen
paymentTermsDaysintegerPflicht
Standard-Zahlungsziel in Tagen
-9007199254740991–9007199254740991
completebooleanPflicht
Pflichtangaben für Rechnungen (§ 14 UStG) vollständig
missingArray<string>Pflicht
Fehlende Angaben (Klartext)

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

curl -X PATCH 'https://www.debt-flow.io/api/v1/company-profile' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "companyName": "string",
  "ownerName": "string",
  "legalForm": "Einzelunternehmen",
  "managingDirectors": "string",
  "address": {
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "[email protected]",
  "website": "string",
  "taxNumber": "string",
  "vatId": "string",
  "smallBusiness": false,
  "commercialRegister": {
    "court": "string",
    "number": "string"
  },
  "bank": {
    "accountHolder": "string",
    "iban": "string",
    "bic": "string",
    "bankName": "string"
  },
  "invoiceFooter": "string",
  "paymentTermsDays": 0
}'

Antwort 200

{
  "companyName": "string",
  "ownerName": "string",
  "legalForm": "string",
  "managingDirectors": "string",
  "address": {
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "string",
  "website": "string",
  "taxNumber": "string",
  "vatId": "string",
  "smallBusiness": false,
  "commercialRegister": {
    "court": "string",
    "number": "string"
  },
  "bank": {
    "accountHolder": "string",
    "iban": "string",
    "bic": "string",
    "bankName": "string"
  },
  "logo": {
    "contentType": "image/png",
    "size": 0,
    "updatedAt": "string"
  },
  "invoiceFooter": "string",
  "paymentTermsDays": 0,
  "complete": false,
  "missing": [
    "string"
  ]
}

Briefbogen-Vorschau als PDF

GET/api/v1/company-profile/letterhead-preview

Erzeugt ein Beispiel-PDF (DIN 5008) mit Absender, Logo und Fußzeile aus den Stammdaten.

Berechtigung: profile:read

Antwort 200

Datei (application/pdf).

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

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

Logo herunterladen

GET/api/v1/company-profile/logo

Berechtigung: profile:read

Antwort 200

Datei (image/*).

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

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

Logo hochladen oder ersetzen

PUT/api/v1/company-profile/logo

PNG oder JPEG, max. 1 MB. Empfohlen: PNG mit transparentem Hintergrund, mind. 600 px breit.

Berechtigung: profile:write

Body (multipart/form-data)

filestring (binary)Pflicht
image/png, image/jpeg, max. 1024 KB

Antwort 200 · CompanyProfile

companyNamestringPflicht
Firma bzw. Name des Unternehmers (erscheint als Absender)
ownerNamestringPflicht
Inhaber/in (bei Einzelunternehmen)
legalFormstringPflicht
managingDirectorsstringPflicht
Geschäftsführung/Vorstand (Pflicht bei Kapitalgesellschaften)
addressobjectPflicht
- streetstringPflicht
- zipCodestringPflicht
- citystringPflicht
- countryCodestringPflicht
phonestringPflicht
emailstringPflicht
websitestringPflicht
taxNumberstringPflicht
Steuernummer des Finanzamts
vatIdstringPflicht
Umsatzsteuer-Identifikationsnummer
smallBusinessbooleanPflicht
Kleinunternehmer nach § 19 UStG (keine Umsatzsteuer ausweisen)
commercialRegisterobjectPflicht
- courtstringPflicht
- numberstringPflicht
bankobjectPflicht
- accountHolderstringPflicht
- ibanstringPflicht
- bicstringPflicht
- bankNamestringPflicht
logoCompanyLogo | nullPflicht
- contentType"image/png" | "image/jpeg"Pflicht
- sizeintegerPflicht
  -9007199254740991–9007199254740991
- updatedAtstringPflicht
invoiceFooterstringPflicht
Eigene Fußzeile auf Rechnungen
paymentTermsDaysintegerPflicht
Standard-Zahlungsziel in Tagen
-9007199254740991–9007199254740991
completebooleanPflicht
Pflichtangaben für Rechnungen (§ 14 UStG) vollständig
missingArray<string>Pflicht
Fehlende Angaben (Klartext)

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

curl

curl -X PUT 'https://www.debt-flow.io/api/v1/company-profile/logo' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -F 'file=@datei'

Antwort 200

{
  "companyName": "string",
  "ownerName": "string",
  "legalForm": "string",
  "managingDirectors": "string",
  "address": {
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "string",
  "website": "string",
  "taxNumber": "string",
  "vatId": "string",
  "smallBusiness": false,
  "commercialRegister": {
    "court": "string",
    "number": "string"
  },
  "bank": {
    "accountHolder": "string",
    "iban": "string",
    "bic": "string",
    "bankName": "string"
  },
  "logo": {
    "contentType": "image/png",
    "size": 0,
    "updatedAt": "string"
  },
  "invoiceFooter": "string",
  "paymentTermsDays": 0,
  "complete": false,
  "missing": [
    "string"
  ]
}

Logo entfernen

DELETE/api/v1/company-profile/logo

Berechtigung: profile:write

Antwort 200 · CompanyProfile

companyNamestringPflicht
Firma bzw. Name des Unternehmers (erscheint als Absender)
ownerNamestringPflicht
Inhaber/in (bei Einzelunternehmen)
legalFormstringPflicht
managingDirectorsstringPflicht
Geschäftsführung/Vorstand (Pflicht bei Kapitalgesellschaften)
addressobjectPflicht
- streetstringPflicht
- zipCodestringPflicht
- citystringPflicht
- countryCodestringPflicht
phonestringPflicht
emailstringPflicht
websitestringPflicht
taxNumberstringPflicht
Steuernummer des Finanzamts
vatIdstringPflicht
Umsatzsteuer-Identifikationsnummer
smallBusinessbooleanPflicht
Kleinunternehmer nach § 19 UStG (keine Umsatzsteuer ausweisen)
commercialRegisterobjectPflicht
- courtstringPflicht
- numberstringPflicht
bankobjectPflicht
- accountHolderstringPflicht
- ibanstringPflicht
- bicstringPflicht
- bankNamestringPflicht
logoCompanyLogo | nullPflicht
- contentType"image/png" | "image/jpeg"Pflicht
- sizeintegerPflicht
  -9007199254740991–9007199254740991
- updatedAtstringPflicht
invoiceFooterstringPflicht
Eigene Fußzeile auf Rechnungen
paymentTermsDaysintegerPflicht
Standard-Zahlungsziel in Tagen
-9007199254740991–9007199254740991
completebooleanPflicht
Pflichtangaben für Rechnungen (§ 14 UStG) vollständig
missingArray<string>Pflicht
Fehlende Angaben (Klartext)

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

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

Antwort 200

{
  "companyName": "string",
  "ownerName": "string",
  "legalForm": "string",
  "managingDirectors": "string",
  "address": {
    "street": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "string",
  "website": "string",
  "taxNumber": "string",
  "vatId": "string",
  "smallBusiness": false,
  "commercialRegister": {
    "court": "string",
    "number": "string"
  },
  "bank": {
    "accountHolder": "string",
    "iban": "string",
    "bic": "string",
    "bankName": "string"
  },
  "logo": {
    "contentType": "image/png",
    "size": 0,
    "updatedAt": "string"
  },
  "invoiceFooter": "string",
  "paymentTermsDays": 0,
  "complete": false,
  "missing": [
    "string"
  ]
}

Angemeldeten Nutzer abrufen

GET/api/v1/me

Gibt Konto und Art der Anmeldung inkl. erteilter Scopes zurück. Geeignet zum Prüfen eines API-Schlüssels.

Jeder gültige API-Schlüssel oder OAuth-Token.

Antwort 200 · Me

idstringPflicht
Nutzer-ID
emailstring | nullPflicht
firstNamestringPflicht
lastNamestringPflicht
companystringPflicht
approvedbooleanPflicht
Konto freigeschaltet
authobjectPflicht
- kind"session" | "api_key" | "oauth"Pflicht
  Art der Anmeldung
- scopesArray<string>Pflicht
  Erteilte Berechtigungen
- apiKeyIdstring
- clientIdstring

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

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

Antwort 200

{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "company": "string",
  "approved": false,
  "auth": {
    "kind": "session",
    "scopes": [
      "string"
    ],
    "apiKeyId": "string",
    "clientId": "string"
  }
}

Benachrichtigungen auflisten

GET/api/v1/notifications

Berechtigung: profile:read

Query-Parameter

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

Antwort 200

object"list"Pflicht
dataArray<Notification>Pflicht
- idstringPflicht
- object"notification"Pflicht
- typestringPflicht
- titlestringPflicht
- bodystringPflicht
- linkstring | nullPflicht
- readbooleanPflicht
- createdAtstring (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/notifications' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "notification",
      "type": "string",
      "title": "string",
      "body": "string",
      "link": "string",
      "read": false,
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Benachrichtigung als gelesen markieren

POST/api/v1/notifications/{id}/read

Berechtigung: profile:write

Pfadparameter

idstringPflicht
ID der Ressource
max. 128 Zeichen

Header

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

Antwort 200 · Notification

idstringPflicht
object"notification"Pflicht
typestringPflicht
titlestringPflicht
bodystringPflicht
linkstring | nullPflicht
readbooleanPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

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

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

Antwort 200

{
  "id": "string",
  "object": "notification",
  "type": "string",
  "title": "string",
  "body": "string",
  "link": "string",
  "read": false,
  "createdAt": "2026-11-01T09:30:00.000Z"
}

Alle Benachrichtigungen als gelesen markieren

POST/api/v1/notifications/read-all

Berechtigung: profile: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

Antwort 200

updatedintegerPflicht
-9007199254740991–9007199254740991

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

curl -X POST 'https://www.debt-flow.io/api/v1/notifications/read-all' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "updated": 0
}

Hinweise: überfällige Forderungen und anstehende Raten

GET/api/v1/notifications/summary

Berechtigung: debts:read, payments:read

Antwort 200 · NotificationSummary

unreadCountintegerPflicht
-9007199254740991–9007199254740991
overdueobjectPflicht
- countintegerPflicht
  -9007199254740991–9007199254740991
- principalCentsintegerPflicht
  Betrag in Cent
  -100000000000–100000000000
upcomingInstallmentsArray<object>Pflicht
- installmentPlanIdstringPflicht
- debtIdstringPflicht
- descriptionstringPflicht
- amountCentsintegerPflicht
  Betrag in Cent
  -100000000000–100000000000
- dueDatestring (date)Pflicht
  Datum (YYYY-MM-DD)

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

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

Antwort 200

{
  "unreadCount": 0,
  "overdue": {
    "count": 0,
    "principalCents": 0
  },
  "upcomingInstallments": [
    {
      "installmentPlanId": "string",
      "debtId": "string",
      "description": "string",
      "amountCents": 0,
      "dueDate": "2026-11-01"
    }
  ]
}

Einstellungen abrufen

GET/api/v1/settings

Name, Organisationsform (Inkasso/Kanzlei) und Automatisierung des Mahnwesens. Firmen- und Bankdaten: /company-profile.

Berechtigung: profile:read

Antwort 200 · AccountSettings

firstNamestringPflicht
lastNamestringPflicht
phonestringPflicht
organizationobjectPflicht
- type"self" | "inkasso" | "kanzlei"Pflicht
- registerNumberstringPflicht
- registerCourtstringPflicht
automationobjectPflicht
- autoDunningbooleanPflicht
  Automatischer Mahnlauf
- dunningIntervalDaysintegerPflicht
  7–60
- autoPostalDefaultbooleanPflicht
  Mahnungen standardmäßig auch per Post
- weeklyReportbooleanPflicht
- installmentRemindersbooleanPflicht
- paymentReceiptsbooleanPflicht
  Zahlungsbestätigung an Schuldner
briefdienerConnectedbooleanPflicht

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

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

Antwort 200

{
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "organization": {
    "type": "self",
    "registerNumber": "string",
    "registerCourt": "string"
  },
  "automation": {
    "autoDunning": false,
    "dunningIntervalDays": 7,
    "autoPostalDefault": false,
    "weeklyReport": false,
    "installmentReminders": false,
    "paymentReceipts": false
  },
  "briefdienerConnected": false
}

Einstellungen ändern

PATCH/api/v1/settings

Z. B. {"automation":{"autoDunning":true,"dunningIntervalDays":14}} schaltet den automatischen Mahnlauf ein.

Berechtigung: profile:write

Body (JSON) · AccountSettingsUpdate

firstNamestring
max. 80 Zeichen
lastNamestring
max. 80 Zeichen
phonestring
max. 40 Zeichen
organizationobject
- type"self" | "inkasso" | "kanzlei"Pflicht
- registerNumberstring
  max. 80 Zeichen
- registerCourtstring
  max. 120 Zeichen
automationobject
- autoDunningboolean
  Automatischer Mahnlauf
- dunningIntervalDaysinteger
  7–60
- autoPostalDefaultboolean
  Mahnungen standardmäßig auch per Post
- weeklyReportboolean
- installmentRemindersboolean
- paymentReceiptsboolean
  Zahlungsbestätigung an Schuldner

Antwort 200 · AccountSettings

firstNamestringPflicht
lastNamestringPflicht
phonestringPflicht
organizationobjectPflicht
- type"self" | "inkasso" | "kanzlei"Pflicht
- registerNumberstringPflicht
- registerCourtstringPflicht
automationobjectPflicht
- autoDunningbooleanPflicht
  Automatischer Mahnlauf
- dunningIntervalDaysintegerPflicht
  7–60
- autoPostalDefaultbooleanPflicht
  Mahnungen standardmäßig auch per Post
- weeklyReportbooleanPflicht
- installmentRemindersbooleanPflicht
- paymentReceiptsbooleanPflicht
  Zahlungsbestätigung an Schuldner
briefdienerConnectedbooleanPflicht

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

curl -X PATCH 'https://www.debt-flow.io/api/v1/settings' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "organization": {
    "type": "self",
    "registerNumber": "string",
    "registerCourt": "string"
  },
  "automation": {
    "autoDunning": false,
    "dunningIntervalDays": 7,
    "autoPostalDefault": false,
    "weeklyReport": false,
    "installmentReminders": false,
    "paymentReceipts": false
  }
}'

Antwort 200

{
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "organization": {
    "type": "self",
    "registerNumber": "string",
    "registerCourt": "string"
  },
  "automation": {
    "autoDunning": false,
    "dunningIntervalDays": 7,
    "autoPostalDefault": false,
    "weeklyReport": false,
    "installmentReminders": false,
    "paymentReceipts": false
  },
  "briefdienerConnected": false
}