bimetricsEntwickler
Forderungen und Mahnungen

Mahnungen und Entwürfe suchen

Als Markdown ansehen

Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)

GET
/api/reminder/

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.

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

Query-Parameter

limit?integer

Seitengröße; Standard 25, höchstens 100.

offset?integer

Anzahl zu überspringender Treffer; Standard 0.

search?string

Suche in Rechnungsnummer und Kundenname.

status?string

Ein oder mehrere kommagetrennte Statuswerte draft, issued und withdrawn; all (Standard) enthält den vollständigen Verlauf.

sort?string

Sortierfeld createdAt (Standard), number, customerName, sourceInvoiceNumber, issueDate, paymentDeadline oder status.

direction?string

Sortierrichtung asc oder desc; Standard desc. Sortierung gilt vor der Seitenauswahl.

sourceDraftId?string

Optionale UUID des Originalrechnungsentwurfs dieser Firma. Filtert vor Gesamtzahl und Seitenauswahl; mit status=draft lässt sich ein bestehender Mahnungsentwurf finden.

Antworten

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"
{  "items": [    {      "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": "MA-2026-0012",      "paymentDeadline": {        "day": 22,        "month": 10,        "year": 2026      },      "printFingerprint": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f",      "snapshot": {        "canCorrect": true,        "canRemind": true,        "correctableMinor": 178500,        "correctedMinor": 0,        "currency": "EUR",        "customerName": "Brauhaus Elbwiese GmbH",        "dueDate": {          "day": 15,          "month": 9,          "year": 2026        },        "invoiceDate": {          "day": 1,          "month": 9,          "year": 2026        },        "number": "RE-2026-0142",        "openMinor": 107100,        "originalGrossMinor": 178500,        "paidMinor": 71400,        "paymentKnown": true,        "receivableVersion": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f",        "refundDueMinor": 0,        "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",        "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",        "sourceLayoutId": "classic",        "sourceVersion": "2026-09-01T08:01:02.123456Z"      },      "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",      "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",      "sourceInvoiceNumber": "RE-2026-0142",      "status": "issued",      "text": "Bitte überweisen Sie den offenen Betrag bis zum genannten Datum.",      "updatedAt": "2026-10-08T08:01:00Z"    }  ],  "total": 1}

Aktuellen Forderungsstand einer Rechnung lesen GET

Die ID bezeichnet den ursprünglichen Rechnungsentwurf. receivableVersion bindet Rechnung, Zahlungen und ausgestellte Korrekturen. Eine bezahlte Rechnung kann weiterhin korrigiert werden; refundDueMinor bezeichnet ein Guthaben des Kunden, keine ausgeführte Auszahlung. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Mahnungsentwurf erstellen POST

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`.