bimetricsEntwickler
Kassenbuch

Z-Bon als Bilder

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/cash-imports/{id}/pages

Liefert den Z-Bon zum Ansehen ohne PDF-Anzeige: die Seiten eines PDFs als PNG-Bilder, höchstens die ersten fünf wie beim Lesen, ein Foto aufrecht gedreht und verkleinert als JPEG. Die Datei selbst liefert getCashImportFile unverändert. Abrufen dürfen es alle Rollen.

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.

Pfadparameter

id*string

ID des Tagesabschlusses (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Der Z-Bon als Bilder.

lines?array<>

Bei einem Tag aus einer Kassendatei statt Seiten seine Buchungszeilen, ohne den Link zum Beleg.

pages?array<>|

Die Seiten in ihrer Reihenfolge: bei einem PDF als PNG, höchstens die ersten fünf, bei einem Foto ein JPEG.

rows?array<string>

Bei einem Kassenabschluss aus einem DSFinV-K-Export die gelesenen Zeilen seiner Dateien, je Zeile Datei, Zeilennummer und Felder; Namen von Kunden und Personal liest bimetrics nicht.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/cash-imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "pages": [    {      "content": "/9j/4AAQSkZJRg==",      "mime": "image/jpeg"    }  ]}