bimetricsEntwickler
Kontoauszüge

Kontoauszug ansehen

Als Markdown ansehen

Benötigte Berechtigung:statements:import(Kontoauszüge einlesen)

Echte Wirkung

Dieser Aufruf ist nicht als rein lesend gekennzeichnet und kann echte Daten in der Firma anlegen oder ändern. Es gibt keine Testumgebung.
post/api/bankstatement/inspect

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

Liest den Anfang der Datei und schlägt Spalten (mapping), Format und Zielkonto vor, mit bis zu 20 Zeilen, wie bimetrics sie liest. Es wird nichts gespeichert. Mit mapping im Anfrageinhalt liest die Route die Zeilen mit dieser Zuordnung.

Benötigt einen Schlüssel mit der Berechtigung statements:import.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Request-Body

Upload und optional die Zuordnung der Spalten

application/json
  1. body

Der Upload und, falls schon festgelegt, Konto und Zuordnung.

bankAccountId?|

Das Konto, falls schon festgelegt.

Formatuuid
mapping?|

Eine Zuordnung, mit der die Zeilen gelesen werden sollen.

uploadId?string

ID des Uploads.

Formatuuid

Antworten

Erfolg.

application/json
  1. response

Vorschlag für das Lesen einer Datei.

account?

Zielkonto.

columns?array<>|

Spalten der Datei mit einem Beispielwert.

dateCandidates?array<string>|

Passende Datumsformate. Mehr als eines: nachfragen.

direct?boolean

Das Konto passt und, bei einer Datei mit Spalten, die gespeicherte Zuordnung. Die Vorschau kann direkt folgen.

fileName?string

Name der Datei.

format?

Erkanntes Format.

invertSuggested?boolean

Die Salden passen nur mit umgekehrtem Vorzeichen.

kind?string

Art der Datei.

mapping?

Vorgeschlagene Zuordnung.

mappingSource?string

saved die zuletzt am Konto benutzte, detected erkannt, request aus der Anfrage.

readableShare?number

Anteil lesbarer Zeilen dieser Stichprobe, 0 bis 1.

rows?array<>|

Bis zu 20 Zeilen, wie bimetrics sie liest.

saved?|

Die gespeicherte Zuordnung des Kontos, falls vorhanden.

uploadId?string

ID des Uploads.

Formatuuid
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/bankstatement/inspect" \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Beispielantwort
{  "account": {    "candidates": [      {        "bankAccountId": "6d3a90f2-1e74-4b8c-a5d0-93c7f2e41b68",        "connected": false,        "ibanLast4": "2051",        "name": "Girokonto",        "nearest": false      }    ],    "fileIbans": [],    "fixedMismatch": null,    "mode": "choose",    "newAccount": null  },  "columns": [    {      "header": "Buchungstag",      "occurrence": 1,      "sample": "01.09.2026"    },    {      "header": "Betrag",      "occurrence": 1,      "sample": "-49,90"    }  ],  "dateCandidates": [    "DD.MM.YYYY"  ],  "direct": false,  "fileName": "umsaetze.csv",  "format": {    "delimiter": ";",    "encoding": "utf-8",    "headerRow": 1,    "preambleLines": 0  },  "invertSuggested": false,  "kind": "csv",  "mapping": {    "amountMode": "single",    "columns": {      "amount": {        "header": "Betrag",        "occurrence": 1      },      "bookingDate": {        "header": "Buchungstag",        "occurrence": 1      }    },    "dateFormat": "DD.MM.YYYY",    "decimalSeparator": ",",    "delimiter": ";",    "encoding": "utf-8",    "headerRow": 1,    "invertSign": false,    "version": 1  },  "mappingSource": "detected",  "readableShare": 1,  "rows": [    {      "amountCents": -4990,      "balanceCents": null,      "bookingDate": "2026-09-01",      "counterpartyName": "Beispiel GmbH",      "error": null,      "line": 2,      "purpose": "Rechnung 1234",      "valueDate": "2026-09-01"    }  ],  "saved": null,  "uploadId": "1b7e4f30-5c2a-4d18-9e63-7a0c2f815d44"}

Import wiederholen POST

Startet einen fehlgeschlagenen Import neu, mit derselben Datei, demselben Konto und derselben Zuordnung, wie „Erneut versuchen“ in der App. Geschriebene Zeilen entstehen nicht doppelt. Einen laufenden Import lässt die Route, wie er ist. Benötigt einen Schlüssel mit der Berechtigung `statements:import`.

Vorschau eines Kontoauszugs POST

Liest die ganze Datei und vergleicht sie mit den Umsätzen des Kontos, ohne etwas zu buchen: neu, schon da, zu prüfen (`review`) oder vorgemerkt, nicht gelesene Zeilen, Salden, DATEV-Hinweise und Warnungen. bimetrics merkt sich diese Vorschau 60 Minuten für `applyStatement`, mit genau diesem Konto und dieser Zuordnung. Liest gerade eine andere Vorschau: `409 BankStatementBusy`, in einer Minute erneut. Benötigt einen Schlüssel mit der Berechtigung `statements:import`.