bimetricsEntwickler
Layouts

Version wiederherstellen

Als Markdown ansehen

Benötigte Berechtigung:layout:write(Layouts und Logo ändern)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/layouts/versions/{id}/restore

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

Legt eine neue Version mit dem Stand einer älteren Version desselben Layouts an, wie „Wiederherstellen“ im Editor; originRef nennt die wiederhergestellte. So lässt sich jede Änderung zurücknehmen. Eine Version mit check: failed lässt sich nicht wiederherstellen. Idempotency-Key bei Wiederholung unverändert senden.

Benötigt einen Schlüssel mit der Berechtigung layout:write.

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 der Version (UUID).

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

Antworten

Erfolg.

application/json
  1. response

Ein Rechnungslayout.

appliesTo?array<string>|

Belegarten, für die das Layout gilt; * für alle ohne eigenes. Leer, wenn es für keine gilt.

archivedAt?|

Archiviert seit; null, solange nicht archiviert.

Formatdate-time
editable?boolean

False für das bisherige Layout classic: Es lässt sich nicht ändern.

id?string

ID des Layouts (UUID); standard für das Layout einer Firma ohne eigenes.

module?string

Modul mit Version, etwa modern@2. classic@1 ist das bisherige Layout ohne Einstellungen.

name?string

Name, etwa „Angebote“.

own?boolean

False, solange die Firma kein eigenes Layout hat; die erste Änderung legt es an.

spec?

Die Gestaltung.

version?|

Aktuelle Version; null ohne eigenes Layout.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/layouts/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore" -X POST \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001"
Beispielantwort
{  "appliesTo": [    "*"  ],  "archivedAt": null,  "editable": true,  "id": "243ee0cc-b1c7-4335-8817-6bc939f0f615",  "module": "modern@2",  "name": "Hansen & Kowalski Werbetechnik GmbH",  "own": true,  "spec": {    "blocks": {},    "brandColor": null,    "module": "modern",    "preset": "modern",    "recipe": "",    "schema": 2,    "values": {      "footer.pageNumber": "auto",      "footer.titles": false,      "page.margin.left": 25    }  },  "version": {    "actor": {      "membershipId": "53cd10a9-c864-4dc3-a777-9860d59efe6c",      "name": "Jana Hansen"    },    "check": "passed",    "createdAt": "2026-11-04T10:15:00Z",    "id": "7a4a67f8-ed2a-4ba3-88c4-ebb928704a41",    "number": 3,    "origin": "api",    "originRef": "b1a72031-ace3-4bdc-a63d-477d6be5d7cb",    "parentId": "16f6234e-8667-42f0-9584-6a397dc5f36a",    "summary": "Stand von 10:15 wiederhergestellt"  }}

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

Layout lesen GET

Liefert ein Layout mit Gestaltung und aktueller Version. Eine ID einer anderen Firma ergibt `404 LayoutNotFound`, ohne Daten. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.