bimetricsEntwickler
Zuordnungen

Zuordnungsvorschläge lesen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

POST
/api/match/suggestions

Liefert die Vorschläge, die die App zu offenen Belegen und Umsätzen zeigt, für bis zu 20 auf einmal: Gegenstück, Begründung, offener Betrag danach und ob die App noch nachfragen würde. Es wird nichts zugeordnet. anchors hat einen Eintrag je Beleg und Umsatz, erst die Belege, je in der Reihenfolge der Anfrage, mit denselben Vorschlägen in derselben Reihenfolge wie einzeln, höchstens limit (1 bis 5, ohne Angabe 3). Ist ein Eintrag schon zugeordnet, steht die Zuordnung in anchorMatchId; lässt er sich nicht lesen oder trägt er manuelle Zahlungen, nennt unavailable den Grund. Beides stört die übrigen Einträge nicht. Vorschläge aus Buchungsvorlagen fehlen. Die Route vergleicht mit allen offenen Belegen und Umsätzen der Firma und hat deshalb ein eigenes Budget, siehe Limits.

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.

Request-Body

Belege und Umsätze, zu denen Vorschläge gelesen werden

application/json
  1. body

Offene Belege und Umsätze, zu denen du Vorschläge liest, zusammen 1 bis 20.

documentIds?array<string>

IDs der Belege.

limit?integer

Höchstens so viele Vorschläge je Beleg oder Umsatz, 1 bis 5. Ohne Angabe 3.

transactionIds?array<string>

IDs der Umsätze.

Antworten

Erfolg.

application/json
  1. response

Die Vorschläge je Beleg und Umsatz der Anfrage.

anchors?array<>|

Ein Eintrag je Beleg und Umsatz, erst die Belege, je in der Reihenfolge der Anfrage.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/match/suggestions" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "anchors": [    {      "documentId": "3026096b-614f-40d3-8749-8acf9b529480",      "items": [        {          "alternativesCount": 0,          "ambiguous": false,          "amountOpenAfterMinor": 0,          "candidate": {            "kind": "transaction",            "transaction": {              "amountMinor": 23800,              "bankAccountId": "8faaa132-ef45-4af2-8dbb-a139b051f10f",              "bookingDate": "2026-10-09",              "counterparty": "Brauhaus Elbwiese GmbH",              "currency": "EUR",              "description": "RE-2026-0142",              "id": "a1ba4b85-5bd8-4cef-bbbd-16eaa2c46033",              "matchStatus": "unmatched",              "status": "booked"            }          },          "category": "payment",          "documentIds": [            "3026096b-614f-40d3-8749-8acf9b529480"          ],          "reasons": [            "amount",            "party_name"          ],          "requiresConfirmation": false,          "score": 3.25,          "suggestionId": "ms1_0a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8f9",          "transactionIds": [            "a1ba4b85-5bd8-4cef-bbbd-16eaa2c46033"          ]        }      ]    }  ]}

Erfasste Zahlung zurücknehmen POST

Nimmt eine erfasste Bar-, Verrechnungs- oder Privatzahlung durch Gegenbuchung zurück. Die ursprüngliche Zahlung und Buchung bleiben in der Historie. Erwartet aktuelle Belegversion und offenen Betrag; auch bei ausgeschalteter Neuerfassung verfügbar. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.

Offenen Zuordnungsbetrag berechnen POST

Berechnet den offenen Betrag für ausgewählte Belege und Umsätze ohne Speicherung. Betrag als Dezimalzahl in Euro. Benötigt einen Schlüssel mit der Berechtigung `read`.