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_HEREAPI Keys erstellen Sie unter Einstellungen → API Keys.
Base URL
https://api.cashmich.com/api/v1Endpoints
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:
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| creditorName | string | Ja | Name des Gläubigers |
| creditorIban | string | Ja | IBAN (15-34 Zeichen) |
| debtorName | string | Ja | Name des Schuldners |
| debtorEmail | string | Ja | E-Mail des Schuldners |
| debtorAddress | string | Nein | Adresse (Freitext, Legacy) |
| debtorStreet | string | Nein | Straße + Hausnummer |
| debtorCity | string | Nein | Ort |
| debtorPostalCode | string | Nein | PLZ |
| debtorCountry | string | Nein | Land (z.B. "AT", "DE") |
| debtorPhone | string | Nein | Telefonnummer |
| amount | number | Ja | Betrag (> 0) |
| currency | string | Nein | Währung (Standard: EUR) |
| invoiceNumber | string | Nein | Rechnungsnummer |
| invoiceDate | string | Nein | Rechnungsdatum (ISO 8601) |
| dueDate | string | Nein | Fälligkeitsdatum (ISO 8601) |
| notes | string | Nein | Notizen |
| smsEnabled | boolean | Nein | SMS-Erinnerungen aktivieren |
| whatsappEnabled | boolean | Nein | WhatsApp-Erinnerungen aktivieren |
| reminderDays | number | Nein | Erinnerungsintervall (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:
| Parameter | Typ | Beschreibung |
|---|---|---|
| status | string | Filter nach Status |
| page | number | Seite (Standard: 1) |
| limit | number | Ergebnisse 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
| Status | Bedeutung |
|---|---|
| 401 | Ungültiger oder fehlender API Key |
| 403 | Fehlende Berechtigung für diese Aktion |
| 404 | Forderung nicht gefunden |
| 422 | Validierungsfehler — prüfen Sie die Pflichtfelder |
| 429 | Rate Limit erreicht — warten und erneut versuchen |
| 500 | Serverfehler — kontaktieren Sie support@cashmich.com |