bimetricsEntwickler
Forderungen und Mahnungen

Ausgestellte Mahnung zurückziehen

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}/withdraw

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

Kennzeichnet die Mahnung als zurückgezogen. Original-PDF und Verlauf bleiben erhalten. Rechnung, Zahlungen und offener Betrag werden nicht verändert.

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

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

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
  1. body

Versionsbedingung für eine Mahnung.

expectedUpdatedAt?|

Exakter zuletzt gelesener updatedAt-Wert einschließlich Sekundenbruchteilen.

Formatdate-time

Antworten

Erfolg.

application/json
  1. response

Eigenständige Mahnung ohne Buchung oder Zahlungsauftrag. Nach Ausstellung bleiben PDF und Forderungssnapshot unverändert.

chargeFee?|

Gespeicherte Wahl zur Mahngebühr: false abgewählt, null oder true Vorschlag.

chargeFlatRate?|

Gespeicherte Wahl zur Pauschale, wie chargeFee.

chargeInterest?|

Gespeicherte Wahl zu den Verzugszinsen, wie chargeFee.

charges?|

Mahngebühr, Verzugszinsen und Pauschale. Beim einzeln gelesenen Entwurf aktuell gerechnet, nach dem Ausstellen eingefroren; null bei Entwürfen in Listen, bei älteren Mahnungen und solange die Rechnung nicht mahnbar ist.

companyId?string

ID der Firma.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
customerName?string

Empfänger der Originalrechnung.

documentMail?

Nur in den Antworten von getReminder und listReminders. Die neueste Mail, mit der diese Mahnung über bimetrics gesendet wurde (aus der App, per API oder per MCP), samt Versandstand. Fehlt, wenn noch keine gesendet wurde. Einen von Hand eingetragenen Versand nennt externalSentOn.

externalSentChannel?string

Dokumentierter externer Weg email, post oder other.

externalSentOn?

Manuell dokumentiertes externes Versanddatum; kein automatischer Versand.

id?string

ID der Mahnung oder ihres Entwurfs.

Formatuuid
issueDate?

Ausstellungsdatum.

kind?string

payment_reminder für Zahlungserinnerung oder dunning für Mahnung.

layoutId?string

Dokumentlayout modern oder classic.

level?integer

Stufe: 0 Zahlungserinnerung, 1 bis 3 Mahnung.

number?string

Mahnungsnummer; bei offenem Entwurf leer.

paymentDeadline?

Zahlungsfrist nach dem Ausstellungsdatum.

printFingerprint?string

Fingerprint des bei Ausstellung verwendeten Druckstands.

snapshot?

Bei Ausstellung eingefrorener Forderungsstand.

sourceDocumentId?string

Ausgestellter Originalbeleg.

Formatuuid
sourceDraftId?string

Originalrechnungsentwurf.

Formatuuid
sourceInvoiceNumber?string

Nummer der Originalrechnung.

status?string

draft, issued oder withdrawn.

text?string

Text im Dokument. Bei Entwürfen mit Platzhaltern, nach dem Ausstellen wie auf dem PDF.

updatedAt?string

Letzte Änderung.

Formatdate-time
withdrawnAt?string

Zeitpunkt des Zurückziehens; Original und Verlauf bleiben erhalten.

Formatdate-time
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/reminder/497f6eca-6276-4993-bfeb-53cbbbba6f08/withdraw" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "chargeFee": null,  "chargeFlatRate": null,  "chargeInterest": null,  "charges": {    "contactId": "b17e8812-eae4-49b6-b5dc-30510635cb07",    "customerKind": "business",    "defaultSince": "2026-09-30",    "fee": {      "amountMinor": 250,      "state": "applied"    },    "flatRate": {      "amountMinor": 0,      "state": "off"    },    "interest": {      "amountMinor": 278,      "days": 9,      "from": "2026-09-30",      "periods": [        {          "amountMinor": 278,          "days": 9,          "from": "2026-09-30",          "ratePercent": "10.52",          "to": "2026-10-08"        }      ],      "state": "applied",      "to": "2026-10-08"    },    "priorFeesMinor": 0,    "priorFlatRateMinor": 0,    "totalChargesMinor": 528,    "totalMinor": 107628  },  "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": "dunning",  "layoutId": "modern",  "level": 1,  "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",    "writtenOffMinor": 0  },  "sourceDocumentId": "3026096b-614f-40d3-8749-8acf9b529480",  "sourceDraftId": "821c3664-640a-4e10-b120-a4ff713532f8",  "sourceInvoiceNumber": "RE-2026-0142",  "status": "withdrawn",  "text": "Bitte überweisen Sie {Gesamtbetrag} bis zum {Frist}.",  "updatedAt": "2026-10-08T08:01:00Z",  "withdrawnAt": "2026-10-08T09:00:00Z"}