bimetricsEntwickler
Forderungen und Mahnungen

Mahnstufe als PDF ansehen

Als Markdown ansehen

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

POST
/api/reminder/settings/{level}/preview

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.

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.

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

Mahnung einer Stufe mit Beispieldaten; nichts wird gespeichert.

pages?array<>|

Geordnete Bildseiten aus genau diesen PDF-Bytes.

pdf?

Vollständige PDF-Datei als Base64.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/reminder/settings/0/preview" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "pages": [],  "pdf": {    "dataBase64": "JVBERi0xLjc=",    "filename": "mahnung-vorschau.pdf",    "mime": "application/pdf"  }}

Frist, Text und Mahngebühr einer Mahnstufe ändern PUT

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

Mahnung lesen GET

Liefert gespeicherten Inhalt, Status und bei Ausstellung den eingefrorenen Forderungsstand. charges nennt Mahngebühr, Verzugszinsen und Pauschale: beim Entwurf so, wie das Ausstellen sie jetzt fordern würde, bei einer ausgestellten Mahnung eingefroren. Den heutigen Stand separat über getReceivable lesen. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.