Zum Hauptinhalt springen

API Reference

CashMich Public API v1 — REST API für Forderungsmanagement.

Authentifizierung

Alle Requests benötigen einen API Key im Authorization Header:

bash
Authorization: Bearer cm_live_YOUR_KEY_HERE

API Keys erstellen Sie unter Einstellungen → API Keys.

Base URL

https://api.cashmich.com/api/v1

Endpoints

POST /claims — Forderung erstellen

bash
curl -X POST https://api.cashmich.com/api/v1/claims \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "creditorName": "Firma GmbH",
    "creditorIban": "AT611904300234573201",
    "debtorName": "Max Mustermann",
    "debtorEmail": "max@example.com",
    "amount": 250.00,
    "invoiceNumber": "RE-2026-001"
  }'

Request Body:

FeldTypPflichtBeschreibung
creditorNamestringJaName des Gläubigers
creditorIbanstringJaIBAN (15-34 Zeichen)
debtorNamestringJaName des Schuldners
debtorEmailstringJaE-Mail des Schuldners
debtorAddressstringNeinAdresse (Freitext, Legacy)
debtorStreetstringNeinStraße + Hausnummer
debtorCitystringNeinOrt
debtorPostalCodestringNeinPLZ
debtorCountrystringNeinLand (z.B. "AT", "DE")
debtorPhonestringNeinTelefonnummer
amountnumberJaBetrag (> 0)
currencystringNeinWährung (Standard: EUR)
invoiceNumberstringNeinRechnungsnummer
invoiceDatestringNeinRechnungsdatum (ISO 8601)
dueDatestringNeinFälligkeitsdatum (ISO 8601)
notesstringNeinNotizen
smsEnabledbooleanNeinSMS-Erinnerungen aktivieren
whatsappEnabledbooleanNeinWhatsApp-Erinnerungen aktivieren
reminderDaysnumberNeinErinnerungsintervall (1-365 Tage)

Response (201):

json
{
  "id": "clm_abc123",
  "status": "submitted",
  "creditorName": "Firma GmbH",
  "amount": 250.00,
  "createdAt": "2026-03-27T10:00:00Z"
}

POST /claims/bulk — Mehrere Forderungen erstellen

bash
curl -X POST https://api.cashmich.com/api/v1/claims/bulk \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "claims": [
      { "creditorName": "Firma GmbH", "creditorIban": "AT61...", "debtorName": "Person A", "amount": 100 },
      { "creditorName": "Firma GmbH", "creditorIban": "AT61...", "debtorName": "Person B", "amount": 200 }
    ]
  }'

Maximal 100 Forderungen pro Request.

GET /claims — Forderungen auflisten

bash
curl https://api.cashmich.com/api/v1/claims \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE"

Query Parameter:

ParameterTypBeschreibung
statusstringFilter nach Status
pagenumberSeite (Standard: 1)
limitnumberErgebnisse pro Seite (Standard: 20)

GET /claims/:id — Einzelne Forderung abrufen

bash
curl https://api.cashmich.com/api/v1/claims/clm_abc123 \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE"

GET /claims/:id/status — Status abrufen

bash
curl https://api.cashmich.com/api/v1/claims/clm_abc123/status \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE"

GET /claims/:id/documents — Dokumente abrufen

bash
curl https://api.cashmich.com/api/v1/claims/clm_abc123/documents \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE"

PUT /claims/:id — Forderung aktualisieren

bash
curl -X PUT https://api.cashmich.com/api/v1/claims/clm_abc123 \
  -H "Authorization: Bearer cm_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 300.00,
    "notes": "Betrag korrigiert"
  }'

Alle Felder aus POST /claims sind optional aktualisierbar.

Fehlercodes

StatusBedeutung
401Ungültiger oder fehlender API Key
403Fehlende Berechtigung für diese Aktion
404Forderung nicht gefunden
422Validierungsfehler — prüfen Sie die Pflichtfelder
429Rate Limit erreicht — warten und erneut versuchen
500Serverfehler — kontaktieren Sie support@cashmich.com
KI-gestützt
Schuldnerfreundlich
DSGVO-konform
€Keine Vorabkosten

Newsletter abonnieren

© 2026 CashMich. Alle Rechte vorbehalten.

Alle Systeme betriebsbereit

Cookies

Wir nutzen Cookies für Betrieb und Verbesserung.

Mehr in der Datenschutzerklärung.