Löschen eines Belegs prüfen
Benötigte Berechtigung:read(Daten lesen)
Sagt, was DELETE /api/document/{id} gerade tun würde, und ändert nichts: outcome deleted (Beleg, Datei und offene Buchungen verschwinden aus bimetrics, es gibt keinen Papierkorb), cancelled (festgeschriebene Buchungen bleiben und werden in ihren Monaten storniert, reversedFinalizedMonths, der Beleg bleibt als storniert stehen) oder retained_copy (eine hochgeladene Kopie derselben Datei übernimmt, Beleg, Buchungen und Zuordnung bleiben). Geht es nicht, nennt refusedBecause den Grund. Sende version, outcome und currentRepresentativeId beim Löschen unverändert mit.
Benötigt einen Schlüssel mit der Berechtigung read.
AuthentifizierungBearer <bm_…>Empfohlen: Authorization: Bearer bm_…. Der Schlüssel wird nur einmal angezeigt; nie in URLs, Logs oder Frontend-Code ablegen.
id*stringID des Objekts in dieser Firma (UUID).
uuidErfolg.
application/json- response
Was das Löschen des Belegs gerade tun würde.
copies?integerHochgeladene Kopien derselben Datei. Mit Kopie ist das Ergebnis retained_copy.
currentRepresentativeId?stringAktuelle Datei-Generation des Belegs; beim Löschen als expectedRepresentativeId senden. Fehlt ohne hochgeladene Datei.
uuiddocumentId?stringID des Belegs.
uuidfromInboxMail?booleanDer Beleg kam aus einer Mail des Belegpostfachs: Nach dem Löschen zeigt die Mail den Anhang weiter als übernommen, und er lässt sich nicht erneut übernehmen.
outcome?stringdeleted, cancelled oder retained_copy. Fehlt, wenn der Beleg sich nicht löschen lässt; beim Löschen als expectedOutcome senden.
refusedBecause?stringWarum es nicht geht: matched, issued, recorded_payments, contract, series, already_cancelled oder exported.
reversedFinalizedMonths?array<string>|Monate (YYYY-MM), in denen festgeschriebene Buchungen storniert werden. Ist die Umsatzsteuer-Voranmeldung eines dieser Monate schon abgegeben, muss sie unter Umständen berichtigt werden.
version?stringFachlicher Versionsdigest; beim Löschen als expectedVersion senden.
curl --fail-with-body "https://app.bimetrics.de/api/document/497f6eca-6276-4993-bfeb-53cbbbba6f08/delete-preview" \ -H "Authorization: Bearer $BIMETRICS_API_KEY"{ "copies": 0, "currentRepresentativeId": "8a1d4e77-2c9b-4f03-b6e2-5c7f10ae34d2", "documentId": "3f6c2a10-7b1e-4c55-9a70-0d2b8e41c9f1", "fromInboxMail": false, "outcome": "cancelled", "reversedFinalizedMonths": [ "2026-09" ], "version": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f"}Originaldatei eines Belegs laden GET
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 oder gelöscht ist. Benötigt einen Schlüssel mit der Berechtigung `read`.
Beleg erneut lesen POST
Startet die Erkennung eines Belegs neu, dessen Lesen fehlgeschlagen ist (`ocrStatus` `failed`), wie „Erneut lesen“ in der App. Der Beleg wartet danach sofort wieder (`ocrStatus` `pending`), die Antwort ist der Beleg in diesem Stand. Die Datei bleibt dieselbe, du lädst nichts neu hoch. Das erneute Lesen zählt im Tarif als weiterer Beleg ins Kontingent. Ist der Beleg schon gelesen, wartet er oder wird er gerade gelesen, antwortet die Route mit `409 DocumentReadingNotFailed`, auch beim zweiten Aufruf. Einen von Hand erfassten Beleg lehnt sie mit `409 DocumentReadingManual` ab, einen mit festgeschriebenen Buchungen mit `409 DocumentReadingFinalized` und eine in bimetrics ausgestellte Rechnung mit `409 DocumentReadingIssued`. Idempotency-Key bei Wiederholung unverändert senden. Benötigt einen Schlüssel mit der Berechtigung `upload`.