bimetricsEntwickler
Forderungen und Mahnungen

Mahnungsentwurf erstellen

Als Markdown ansehen

Benötigte Berechtigung:invoices:draft(Rechnungsentwürfe verwalten)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/reminder/

Kein Testversand aus der Dokumentation: Dieser Aufruf ist nicht als rein lesend gekennzeichnet. Nutze das Codebeispiel.

Erstellt payment_reminder (Zahlungserinnerung) oder dunning (Mahnung) für eine geeignete ausgestellte Rechnung. expectedReceivableVersion muss dem zuletzt geprüften Forderungsstand entsprechen. Keine Gebühren, Buchungen oder Nachrichten.

Benötigt einen Schlüssel mit der Berechtigung invoices:draft.

Authentifizierung

AuthentifizierungBearer <token>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

In: header

Header-Parameter

Idempotency-Key*string

Stabiler Schlüssel für genau diese Änderung: 1–128 druckbare ASCII-Zeichen ohne Leerzeichen. Bei Wiederholungen denselben Schlüssel und unveränderten Inhalt senden; das Ergebnis wird nicht nochmals erzeugt.

Muster^[!-~]+$
Länge1 <= length <= 128

Request-Body

application/json

TypeScript-Typen

Typ request body für TypeScript.

Neue Mahnung als Entwurf für eine geprüfte Forderung.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/reminder/" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-10-08T08:00:00Z",  "customerName": "Brauhaus Elbwiese GmbH",  "id": "c58b1bf1-a4d7-45a8-944c-c97d54954314",  "issueDate": {    "day": 8,    "month": 10,    "year": 2026  },  "kind": "payment_reminder",  "layoutId": "modern",  "number": "",  "paymentDeadline": {    "day": 22,    "month": 10,    "year": 2026  },  "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",  "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",  "sourceInvoiceNumber": "RE-2026-0142",  "status": "draft",  "text": "Bitte überweisen Sie den offenen Betrag bis zum genannten Datum.",  "updatedAt": "2026-10-08T08:01:00Z"}

Mahnungen und Entwürfe suchen GET

Liefert Mahnungsentwürfe, ausgestellte und zurückgezogene Mahnungen. status=all schließt den unveränderlichen Verlauf ein. Ein dokumentierter externer Versand ist kein Versandauftrag oder Zustellnachweis. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Mahnung lesen GET

Liefert gespeicherten Inhalt, Status und bei Ausstellung den eingefrorenen Forderungsstand. Den heutigen Stand separat über getReceivable lesen. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.