bimetricsEntwickler
Layouts

Layout zurückholen

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/{id}/unarchive

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

Holt ein archiviertes Layout zurück. Es gilt danach für keine Belegart.

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 des Layouts (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/497f6eca-6276-4993-bfeb-53cbbbba6f08/unarchive" -X POST \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001"
Beispielantwort
{  "appliesTo": [],  "archivedAt": null,  "editable": true,  "id": "80beabd8-a0ea-4304-b6b3-6a7e9fa709c2",  "module": "modern@2",  "name": "Angebote (Kopie)",  "own": true,  "spec": {    "blocks": {},    "brandColor": null,    "module": "modern",    "preset": "modern",    "recipe": "friendly",    "schema": 2,    "values": {      "footer.pageNumber": "auto",      "footer.titles": false,      "header.rule": false,      "items.head.style": "brand",      "page.margin.left": 25,      "title.brand": true    }  },  "version": {    "actor": {      "membershipId": "53cd10a9-c864-4dc3-a777-9860d59efe6c",      "name": "Jana Hansen"    },    "check": "passed",    "createdAt": "2026-11-04T10:15:00Z",    "id": "3d9e1f4a-7b2c-4c8d-9e0f-1a2b3c4d5e6f",    "number": 1,    "origin": "api",    "originRef": "e1c5d5b2-3f0e-4f43-9a7c-2b7f0d5c8a11",    "parentId": null,    "summary": "Dupliziert aus „Angebote“"  }}

Layout kopieren POST

Kopiert den aktuellen Stand eines Layouts in ein neues Layout „… (Kopie)“, das für keine Belegart gilt; zuweisen mit `assignLayouts`. Ein archiviertes Layout ergibt `404`. Benötigt einen Schlüssel mit der Berechtigung `layout:write`.

Versionen lesen GET

Liefert die Versionen eines Layouts, die neueste zuerst, höchstens 50 je Seite, jede mit der Änderung in einer Zeile (`summary`), Herkunft (`origin`), Person und Gestaltung. Für die nächste Seite `nextBefore` als `before` senden. Versionen werden nie gelöscht. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.