bimetricsEntwickler
Belege

Duplikate entfernen

Als Markdown ansehen

Benötigte Berechtigung:documents:delete(Belege löschen)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/document/duplicates/delete

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

Entfernt ausgewählte Duplikat-Einträge, wie „Duplikat löschen“ in der App, höchstens 1000 auf einmal. Beleg, Datei, Buchungen und Zuordnung bleiben. Danach hält keine Kopie mehr den Beleg, wenn das Original gelöscht wird. Ist eine ID unbekannt, antwortet die Route mit 404 und entfernt nichts. Eine Wiederholung mit gleichem Idempotency-Key entfernt nichts doppelt und meldet replayed.

Benötigt einen Schlüssel mit der Berechtigung documents:delete.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

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

Request-Body

IDs der Duplikat-Einträge

application/json
  1. body

Die Einträge, die entfernt werden sollen.

duplicateIds?array<>|

IDs der Einträge, 1 bis 1000.

Antworten

Erfolg.

application/json
  1. response

Was das Entfernen getan hat.

deleted?integer

Einträge, die dieser Aufruf entfernt hat; bei einer Wiederholung 0.

replayed?boolean

True bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/document/duplicates/delete" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "deleted": 1}

Duplikate lesen GET

Listet die Duplikat-Einträge der Firma, neueste zuerst: Eine Datei wurde erneut hochgeladen, die die Firma schon hat, und es entstand kein zweiter Beleg. Das sind die Zeilen, die die Belegliste der App als Duplikat zeigt. Benötigt einen Schlüssel mit der Berechtigung `read`.

Belege suchen POST

Sucht Belege der Firma mit einem Filter und liefert eine Seite der Treffer (`items`) mit der Gesamtzahl (`total`). Ohne Filter (`{}`) liefert die Route alle Belege, die nicht gelöscht sind, höchstens 1000 je Seite. Gelöschte Belege, auch solche, die bimetrics beim Löschen behält, etwa wegen festgeschriebener Buchungen, kommen nur mit `includeDeleted`. Benötigt einen Schlüssel mit der Berechtigung `read`.