bimetricsEntwickler
Forderungen und Mahnungen

Extern erfolgten Versand dokumentieren

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/{id}/external-send

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

Dokumentiert ausschließlich einen bereits außerhalb von bimetrics vorgenommenen Versand. Weder Versandauftrag noch Zustellnachweis; das PDF bleibt unverändert.

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

Pfadparameter

id*string

ID des Objekts dieser Firma (UUID); bei Forderungsständen und neuen Korrekturen die Quellentwurfs-ID.

Formatuuid

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.

Dokumentation eines extern bereits erfolgten Versands; kein Versandauftrag.

Antworten

application/json

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/external-send" \  -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",  "externalSentChannel": "email",  "externalSentOn": {    "day": 8,    "month": 10,    "year": 2026  },  "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"}

Mahnungs-PDF laden GET

Liefert ausschließlich bei ausgestellten oder zurückgezogenen Mahnungen die gespeicherten Originalbytes. Für Entwürfe previewReminder verwenden. Keine Nachricht wird versendet. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Geprüfte Mahnung ausstellen POST

Stellt genau die mit expectedUpdatedAt und previewToken geprüfte Mahnung aus. Geänderte Forderung oder Druckdaten erfordern eine neue Vorschau. Die Nummer, der Forderungssnapshot und das Original-PDF bleiben unveränderlich. Keine Buchung und kein Versand. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.