Vorschau rendern
Benötigte Berechtigung:sales:read(Ausgangsrechnungen und Entwürfe lesen)
Rendert ein Layout als SVG-Seiten und speichert nichts: das aktuelle Layout einer Belegart, eine Version (versionId) oder eine Gestaltung (spec), jeweils mit ungespeicherten Operationen (operations, wie bei changeLayout). Gezeigt wird ein Musterbeleg mit den Daten der Firma (source.kind sample mit documentType und case aus dem Katalog), ein eigener Entwurf (draft mit documentType und id) oder ein ausgestellter Beleg (issued mit id). Je Firma läuft eine Vorschau: Eine neuere, auch im Editor, beendet die ältere mit 409 PreviewSuperseded. Eine ID einer anderen Firma ergibt 404 LayoutNotFound. Es gelten dieselben Grenzen wie in der App, dazu 60 Aufrufe je Minute und Schlüssel.
Benötigt einen Schlüssel mit der Berechtigung sales:read oder read.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
Optional versionId oder spec, nicht beides; ohne beide das aktuelle Layout der Belegart. Optional operations (höchstens 20) und source, ohne source ein Muster der Rechnung.
application/json- body
Erfolg.
application/json- response
Eine gerenderte Vorschau; gespeichert wird nichts.
notice?"amounts_differ"amounts_differ: Ein ausgestellter Beleg zeigt eine andere Summe als gespeichert, etwa bei alten Angeboten. Der Beleg selbst bleibt, wie er ist.
"amounts_differ"pages?array<string>|Die Seiten als SVG.
version?|Die gezeigte gespeicherte Version; null mit spec, mit ungespeicherten Operationen oder ohne eigenes Layout.
curl --fail-with-body "https://app.bimetrics.de/api/layouts/preview" \ -H "Authorization: Bearer $BIMETRICS_API_KEY" \ -H "Content-Type: application/json" \ -d '{"operations":[{"op":"set","path":"header.logo.size","value":"L"},{"op":"brandColor","value":"#1F5F5B"}],"source":{"case":"standard","documentType":"invoice","kind":"sample"}}'{ "pages": [ "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 595.28 841.89\">…</svg>" ], "version": null}Erlaubte Werte lesen GET
Liefert, was ein Layout wählen kann: die Module mit Bereichen, Eigenschaften und erlaubten Werten, die Vorlagen (`presets`) mit ihren Kombinationen aus Schrift und Farbe (`recipes`), die Belegarten, die Musterfälle der Vorschau und die Bausteine. Pfade und Werte für `set` stehen unter `modules[].properties`, Grenzen zwischen Werten unter `modules[].limits`. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.
Miniaturen rendern POST
Rendert die erste Seite von bis zu 12 Layouts als kleines PNG, je auf dem Musterbeleg einer Belegart, wahlweise mit ungespeicherten Operationen. Speichert nichts. Je Firma rendert ein Aufruf, ein weiterer wartet. Es gelten dieselben Grenzen wie in der App, dazu 60 Aufrufe je Minute und Schlüssel. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.