bimetricsEntwickler
Zuordnungen

Belege und Umsätze zuordnen

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/

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

Ordnet vorhandene Belege und Bankumsätze zu. Alle IDs müssen zur Firma gehören; parallele oder bereits vorhandene Zuordnungen werden geprüft. Die Änderung erzeugt vorbereitete Buchungen.

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

Authentifizierung

AuthentifizierungBearer <token>

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

In: header

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

application/json

Selected document, transaction and series UUIDs

TypeScript-Typen

Typ request body für TypeScript.

Vorhandene Belege und Umsätze zuordnen.

Antworten

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl --fail-with-body "https://app.bimetrics.de/api/match/" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001" \  -H "Content-Type: application/json" \  -d '{}'
{  "match": {    "amountOpen": 0,    "autoMatch": true,    "bankTransactions": [      {        "bankTransactionId": "a1ba4b85-5bd8-4cef-bbbd-16eaa2c46033",        "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",        "createdAt": "2026-09-12T07:30:15Z",        "id": "840529df-2d2a-42ea-afa3-3704d855634f",        "matchId": "e21b3d18-17ea-4318-810c-919ec0a94dcb",        "updatedAt": "2026-09-12T07:30:15Z"      }    ],    "category": "payment",    "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",    "createdAt": "2026-09-12T07:30:15Z",    "documents": [      {        "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",        "createdAt": "2026-09-12T07:30:15Z",        "documentId": "3026096b-614f-40d3-8749-8acf9b529480",        "id": "3432135f-5b01-4288-9764-e1ff7d061777",        "matchId": "e21b3d18-17ea-4318-810c-919ec0a94dcb",        "updatedAt": "2026-09-12T07:30:15Z"      }    ],    "id": "e21b3d18-17ea-4318-810c-919ec0a94dcb",    "matchingRule": null,    "matchingRuleId": null,    "updatedAt": "2026-09-12T07:30:15Z"  },  "replayed": false}

Gespeicherten Rechnungsentwurf prüfen POST

Prüft den gespeicherten Entwurf und liefert Steuerfall, Problemcodes und vorgesehene Konten. Legt keine Kontakte, Rechnungen oder Buchungen an. Kein Anfrageinhalt erforderlich. Benötigt einen Schlüssel mit der Berechtigung `invoices:draft`.

Bereits erfolgte Zahlung erfassen POST

Dokumentiert eine bereits erfolgte Bar- oder Verrechnungszahlung zu einem Beleg. Standardmäßig ausgeschaltet (manualPaymentsEnabled); erwartet expectedAmountOpenMinor zusätzlich zur Belegversion. Betrag in Cent, Währung EUR. Das Gegenkonto bestimmt der Server. Erzeugt weder eine Banktransaktion noch einen Zahlungsauftrag. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.