bimetricsEntwickler
Belege

Originaldatei eines Belegs laden

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/document/{id}/content

Liefert die hochgeladene Originaldatei als Binärdaten. PDFs und Bilder kommen mit ihrem Typ (application/pdf, image/png, image/jpeg), alles andere, etwa XML-E-Rechnungen, als application/octet-stream. Der ETag ist der SHA-256 der Datei (Hex, ohne Anführungszeichen); mit genau diesem Wert in If-None-Match antwortet die Route mit 304 ohne Inhalt. 404, wenn der Beleg keine Originaldatei hat.

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

Unveränderte Datei (304)

Das Beispiel sendet kein If-None-Match und lädt die Datei immer. Schickst du den ETag einer früheren Antwort in If-None-Match mit und ist die Datei unverändert, antwortet die API mit 304 ohne Inhalt und ohne ETag. Behalte dann die gespeicherte Datei, statt sie mit der leeren Antwort zu überschreiben. Ein vollständiges Beispiel steht im Monatsexport.

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

Pfadparameter

id*string

ID des Belegs (UUID).

Formatuuid

Query-Parameter

download?string

Beliebiger nicht leerer Wert, z. B. 1: Die Antwort trägt Content-Disposition: attachment mit dem ursprünglichen Dateinamen.

Header-Parameter

If-None-Match?string

ETag einer früheren Antwort; stimmt er, antwortet die Route mit 304.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/document/497f6eca-6276-4993-bfeb-53cbbbba6f08/content" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  --output beleg.pdf

Binärdaten: die Datei selbst, kein JSON.