bimetricsEntwickler
Zuordnungen

Aufheben einer Zuordnung prüfen

Als Markdown ansehen

Benötigte Berechtigung:read(Daten lesen)

GET
/api/match/{id}/delete-preview

Liefert die aktuellen Versionsbedingungen und IDs der Serienbelege, die beim Aufheben gelöscht würden. exportedMonths nennt die Monate, in denen Buchungen der Zuordnung schon an DATEV exportiert sind; dann braucht DELETE confirmExported: true, nachdem der Nutzer diese Monate bestätigt hat. Verändert nichts. Prüfe die betroffenen Belege vor DELETE und sende expectedVersions unverändert.

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.

Pfadparameter

id*string

ID des Objekts in dieser Firma (UUID).

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Vorschau vor dem Aufheben einer Zuordnung.

deletedSeriesDocumentIds?array<>|

Aus Vorlagen erzeugte Belege, die dabei gelöscht würden.

expectedVersions?|

Unverändert mit dem geprüften DELETE-Aufruf senden.

exportedMonths?array<string>|

Monate (JJJJ-MM), in denen Buchungen der Zuordnung, ihrer Belege oder ihrer Umsätze schon an DATEV exportiert sind; leer, wenn es keine gibt. Steht hier ein Monat, braucht DELETE confirmExported: true. Storniert wird höchstens in diesen Monaten und nur, was sich ändert.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/match/497f6eca-6276-4993-bfeb-53cbbbba6f08/delete-preview" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "deletedSeriesDocumentIds": [],  "expectedVersions": {    "e21b3d18-17ea-4318-810c-919ec0a94dcb": "0e8ca8e3db88d8d5b74c965d0e17598a5909240c88376e0b0a4a23e53ee9356f"  },  "exportedMonths": []}

Skonto einer Zuordnung prüfen GET

Sagt, ob sich der offene Betrag einer Zuordnung als Skonto ausgleichen lässt, und liefert, was der Nutzer vorher bestätigt: Belegnummer, Verwendungszweck, Belegbetrag, Zahlung, Skonto und Prozent. `reference.otherNumbers` nennt Nummern im Verwendungszweck, die wie eine Belegnummer aussehen, wenn die eigene dort fehlt: Die Zahlung kann zu einem anderen Beleg gehören. Es gilt dieselbe Prüfung wie beim ersten Zuordnen: ein gebuchter Euro-Umsatz und genau ein Beleg, bei erhaltenem Skonto auch mehrere Eingangsbelege desselben Lieferanten mit einem Steuersatz; höchstens 5 % Differenz und keine ausgeschlossene Kategorie oder Steuerart. Bei mehreren Belegen nennt `cashDiscount.documents` den Anteil jedes Belegs. Nennt die Zahlungsbedingung einer Rechnung genau dieses Skonto, trägt sie es allein; nennen die Rechnungen zusammen genau diese Summe, trägt jede ihr eigenes; sonst verteilt es sich nach Rechnungsbetrag. Eine Gutschrift des Lieferanten hat den Anteil 0. `reference.documents` nennt ihre Nummern. Beträgt die Differenz höchstens 5 % der Rechnungen und gibt es trotzdem kein Skonto, sagt `reason` warum: `supplier`, `category`, `taxRates` oder `documentAmount`. Ist der Beleg in einer Fremdwährung und fehlt sein Euro-Betrag noch, ist die Differenz meist der Wechselkurs: dann kein Skonto (`CashDiscountForeignCurrency`). Passt die Zuordnung nicht, antwortet die API mit `eligible: false` und nennt in `refusal` den Code. Verändert nichts. Benötigt einen Schlüssel mit der Berechtigung `read`.

Euro-Betrag aus der Zahlung übernehmen POST

Bucht den Beleg einer Zuordnung, der in einer Fremdwährung ist, mit dem Euro-Betrag seiner Zahlungen, wie „Euro-Betrag übernehmen“ in der App. Rufe das erst auf, wenn der Nutzer die Werte aus `previewMatchEuroAmount` bestätigt hat und die Zahlungen den ganzen Beleg decken, keine Teilzahlung. bimetrics rechnet jede Position anteilig auf die Summe der Zahlungen um, Steuersätze, Kategorien, Belegwährung und Originalbetrag bleiben; die Zuordnung bleibt bestehen, ihr offener Betrag ist danach null, und `euroAmountSource` steht auf `payment`. Der Bankbetrag folgt dem Kurs der Bank; für die deutsche Umsatzsteuer gilt grundsätzlich der Monatskurs des Bundesfinanzministeriums, das prüft die Steuerberatung. `expectedVersions` kommt unverändert aus `previewMatchEuroAmount`. Eine Wiederholung mit gleichem Schlüssel bucht nichts erneut. Nicht möglich, wenn die Zuordnung nicht passt (`400 EuroAmountNotEligible`, der Grund steht in `detail`) und wenn Buchungen schon an DATEV exportiert sind (`409 FinalizedBookingsLocked`); andere festgeschriebene Buchungen bleiben stehen und werden storniert und neu gebucht. Benötigt einen Schlüssel mit der Berechtigung `matching:write`.