bimetricsEntwickler
Logo

Logo lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/company/logos

Liefert das aktive Rechnungslogo mit Größe, Auflösung im Logo-Rahmen des Layouts (dpiInFrame) und Hinweisen, einen offenen Vorschlag von „Mach es passend“, die helle Fassung und das App-Zeichen. Die Bilder lädt GET /api/blob/{sha256}/{id} mit blob.sha256 und blob.id, mit demselben Schlüssel. Die IDs der aktiven Bilder sind expectedLogoId der Änderungen.

Benötigt einen Schlüssel mit der Berechtigung read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.

Antworten

Erfolg.

application/json
  1. response

Das Logo der Firma. Ändern geht mit layout:write und gilt für alle Layouts.

app?|

Das App-Zeichen; null für das bimetrics-Zeichen.

enabled?boolean

Immer true, das Logo lässt sich ändern.

frame?

Der Logo-Rahmen des Layouts der Firma.

invoice?|

Das Rechnungslogo; null ohne Logo.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/company/logos" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "app": {    "dark": {      "blob": {        "id": "3e9b1c5a-7d24-4f8e-b6a0-1c9d3e5f70e5",        "sha256": "e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5e5"      }    },    "id": "8a41e7d3-6c25-4b9f-a0d8-2e5f7c3b1d94",    "light": {      "blob": {        "id": "3e9b1c5a-7d24-4f8e-b6a0-1c9d3e5f70d4",        "sha256": "d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4d4"      }    },    "source": "mark"  },  "enabled": true,  "frame": {    "heightMm": 16,    "layout": "modern",    "widthMm": 48  },  "invoice": {    "active": {      "blob": {        "id": "3e9b1c5a-7d24-4f8e-b6a0-1c9d3e5f70a1",        "sha256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"      },      "dpiInFrame": 317,      "height": 600,      "id": "5f0c9f1e-2b7a-4c55-9d1a-7d2f5b0e3a41",      "variant": "fitted",      "width": 1200    },    "canRestoreOriginal": false,    "facts": {      "aspectRatio": 3,      "color": "#1F5F5B",      "contrastOnWhite": 9.4    },    "hints": [      "wide_border"    ],    "inverse": {      "blob": {        "id": "3e9b1c5a-7d24-4f8e-b6a0-1c9d3e5f70b2",        "sha256": "b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2"      },      "height": 600,      "width": 1200    },    "proposal": {      "blob": {        "id": "3e9b1c5a-7d24-4f8e-b6a0-1c9d3e5f70c3",        "sha256": "c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3c3"      },      "dpiInFrame": 635,      "fixes": [        "crop"      ],      "height": 400,      "id": "c2d6a8e4-91b3-4f0a-8e5c-3b7d1a9f6e20",      "width": 1200    }  }}

Rechnungslogo löschen DELETE

Löscht das Rechnungslogo mit allen Fassungen und das Zeichen, das bimetrics daraus gemacht hat; ein eigenes App-Zeichen bleibt. Neue Belege und offene Entwürfe drucken danach ohne Logo, ausgestellte Belege behalten ihres. Nicht umkehrbar. Benötigt einen Schlüssel mit der Berechtigung `layout:write`.

App-Zeichen löschen DELETE

Löscht das eigene App-Zeichen. bimetrics macht das Zeichen wieder aus dem Rechnungslogo, ohne Rechnungslogo zeigt die App das bimetrics-Zeichen. Benötigt einen Schlüssel mit der Berechtigung `layout:write`.