bimetricsEntwickler
Forderungen und Mahnungen

Frist, Text und Mahngebühr einer Mahnstufe ändern

Als Markdown ansehen

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

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
put/api/reminder/settings/{level}

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

Frist und Text gelten für neue Entwürfe. Die Mahngebühr gilt für alle noch nicht ausgestellten Mahnungen der Stufe; ausgestellte bleiben unverändert. Ohne Frist, Text und Gebühr gilt wieder der Standard, auch für die Gebühr. Unbekannte Platzhalter werden abgelehnt. Nur für den Inhaber.

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

level*integer

Mahnstufe: 0 Zahlungserinnerung, 1 bis 3 Mahnung.

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

Neue Frist, neuer Text und Mahngebühr einer Stufe; ohne alle Angaben gilt wieder der Standard, auch für die Gebühr.

deadlineDays?integer

Zahlungsfrist in Tagen, 1 bis 365.

feeEnabled?boolean

Mahngebühr ein oder aus; ohne Angabe bleibt der gespeicherte Wert.

feeMinor?integer

Mahngebühr in Cent, 0 bis 5000; nur tatsächliche Kosten wie Porto. Ohne Angabe bleibt der gespeicherte Wert.

text?string

Text mit erlaubten Platzhaltern, höchstens 12.000 Zeichen.

Antworten

Erfolg.

application/json
  1. response

Frist, Text und Mahngebühr, mit denen neue Mahnungen einer Stufe beginnen.

custom?boolean

true, wenn die Firma eigene Werte gesetzt hat; sonst gilt der Standard.

deadlineDays?integer

Zahlungsfrist in Tagen nach dem Ausstellungsdatum.

feeEnabled?boolean

true, wenn Mahnungen dieser Stufe die Mahngebühr fordern; standardmäßig aus.

feeMinor?integer

Mahngebühr in Cent, 0 bis 5000. Vorschlag: 0 für die Zahlungserinnerung, 250 für eine Mahnung. Gefordert erst ab Verzug, also nicht mit der ersten Mahnung.

level?integer

Stufe: 0 Zahlungserinnerung, 1 bis 3 Mahnung.

text?string

Text mit Platzhaltern in geschweiften Klammern.

title?string

Titel auf dem PDF, zum Beispiel 2. Mahnung.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/reminder/settings/0" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "custom": true,  "deadlineDays": 7,  "feeEnabled": true,  "feeMinor": 250,  "level": 2,  "text": "Die Rechnung {Rechnungsnummer} ist noch offen. Bitte überweisen Sie {Gesamtbetrag} bis spätestens {Frist}.",  "title": "2. Mahnung"}

Verzugszinsen und Pauschale ein- oder ausschalten PUT

Schaltet für alle noch nicht ausgestellten Mahnungen Verzugszinsen nach § 288 BGB und die Pauschale von 40 € (nur gegenüber Unternehmen, einmal je Rechnung) ein oder aus. Gefordert wird beides erst ab Verzug, also nach Ablauf der Frist der ersten Mahnung. Ausgestellte Mahnungen bleiben unverändert. Nur für den Inhaber. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.

Mahnstufe als PDF ansehen POST

Rendert eine Mahnung der Stufe mit Beispieldaten im Layout der Firma, auch mit noch nicht gespeicherten Werten. Eine eingeschaltete Mahngebühr steht als eigene Zeile darin. Speichert nichts. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.