bimetricsEntwickler
Zuordnungen

Zuordnungsvorschlag ausblenden

Als Markdown ansehen

Benötigte Berechtigung:matching:write(Belege und Zahlungen zuordnen)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/match/dismiss

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

Blendet einen Vorschlag aus listMatchSuggestions aus, wie „Vorschlag ausblenden“ in der App: Er erscheint für niemanden in der Firma mehr, und die automatische Zuordnung nimmt genau diese Kombination nicht mehr. Es wird nichts zugeordnet, gebucht oder gelöscht; Belege und Umsätze bleiben für andere Zuordnungen offen. unmatchedId in der Antwort holt ihn mit restoreMatchSuggestion zurück.

Benötigt einen Schlüssel mit der Berechtigung matching:write.

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

Der Vorschlag mit seinen Belegen und Umsätzen

application/json
  1. body

Der Vorschlag, wie listMatchSuggestions ihn liefert.

documentIds?array<>|

documentIds des Vorschlags; darf leer sein.

suggestionId?string

suggestionId des Vorschlags.

transactionIds?array<>|

transactionIds des Vorschlags; darf leer sein.

Antworten

Erfolg.

application/json
  1. response

Die ausgeblendete oder zurückgeholte Kombination.

replayed?boolean

true bei einer Wiederholung mit demselben Idempotency-Key; es wurde nichts erneut geändert.

unmatchedId?string

ID der Kombination; restoreMatchSuggestion nimmt sie.

Formatuuid
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/match/dismiss" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "replayed": false,  "unmatchedId": "2f6d1c0e-7a54-4b1e-9c3a-5d8e7f6a4b21"}

Geeignete Rechnungen für eine Verrechnung suchen GET

Liefert bis zu 20 geeignete offene Ausgangsrechnungen derselben Firma und desselben Kunden. Maßgeblich sind Kontakt-ID und Kundennummer aus den ausgestellten Originalen sowie das gebuchte Personenkonto. Die ursprüngliche Rechnung, Stornos, unklare Zahlungsstände und Belege mit an DATEV exportierten Buchungen sind ausgeschlossen. Bei hasMore=true die Rechnungsnummer mit search weiter eingrenzen. Benötigt einen Schlüssel mit der Berechtigung `sales:read` oder `read`.

Ausgeblendeten Vorschlag zurückholen DELETE

Holt eine ausgeblendete Kombination zurück, wie das Rückgängig nach „Vorschlag ausblenden“ in der App: Sie erscheint wieder, und die automatische Zuordnung darf genau diese Kombination wieder nehmen. Es wird nichts zugeordnet oder gebucht. Eine Wiederholung mit demselben `Idempotency-Key` ändert nichts; gibt es die Kombination in dieser Firma nicht (mehr), antwortet die Route sonst mit `404`. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.