Endpunkte
Alle Endpunkte der bimetrics API mit Parametern, Antworten und Playground.
Die Referenz entsteht aus der OpenAPI-Beschreibung des Backends. Alle Pfade beginnen mit https://app.bimetrics.de/api/, authentifiziert wird mit Authorization: Bearer bm_… (siehe Authentifizierung).
Belege
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
POST /api/document/ | Beleg hochladen | upload |
POST /api/document/filter | Belege suchen | read |
GET /api/document/{id} | Beleg lesen | read |
GET /api/document/{id}/content | Originaldatei eines Belegs laden | read |
Kontakte
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
POST /api/contact/filter | Kontakte suchen | read |
GET /api/contact/{id} | Kontakt lesen | read |
Bankkonten
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
POST /api/bankaccount/filter | Bankkonten suchen | read |
GET /api/bankaccount/{id} | Bankkonto lesen | read |
Umsätze
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
POST /api/banktransaction/filter | Umsätze suchen | read |
GET /api/banktransaction/{id} | Umsatz lesen | read |
Buchhaltung
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
GET /api/accounting/accounts/ | Bebuchte Konten auflisten | read |
GET /api/accounting/accounts/labels/ | Kontenbezeichnungen auflisten | read |
POST /api/accounting/booking/filter | Buchungen suchen | read |
GET /api/accounting/booking/{id} | Buchung lesen | read |
Tarif
| Endpunkt | Beschreibung | Berechtigung |
|---|---|---|
GET /api/entitlement/ | Tarif und Kontingent lesen | read |
Playground
Auf den Seiten der lesenden Endpunkte kannst du Anfragen direkt ausprobieren. Der Playground sendet sie aus deinem Browser unmittelbar an app.bimetrics.de; der Schlüssel läuft nicht über developer.bimetrics.de.
- Aus dem Browser funktioniert nur
Authorization: Bearer. Den HeaderX-API-KEYlässt der Browser nicht zu, weilapp.bimetrics.deihn bei Anfragen von anderen Websites (CORS) nicht erlaubt. - Der Schlüssel bleibt nur während deines Besuchs im Browser gespeichert. Er wird gelöscht, wenn du die Seite verlässt oder neu lädst. Überspringt der Browser das, wird er beim nächsten Besuch gelöscht.
Die Antworten enthalten echte Daten deiner Firma. Nutze den Playground nur auf einem Gerät, dem du vertraust. Für den Upload gibt es keinen Testversand, weil jeder Aufruf einen echten Beleg anlegt.
Changelog
Änderungen an der bimetrics API, neueste zuerst.
Beleg hochladen POST
Lädt genau eine Datei als neuen Beleg hoch und stößt die Erkennung an. Die Antwort ist ein Array mit genau einem Beleg. Das Formularfeld bestimmt die Belegart: `invoice[]` Ausgangsrechnung, `receipt[]` Eingangsbeleg, `auto[]` Erkennung durch bimetrics. Unterstützt werden PDF, PNG, JPEG und XML-E-Rechnungen. `X-Upload-Request-Id` macht Wiederholungen sicher: Dieselbe ID mit identischer Datei, identischem Dateinamen und Feld liefert denselben Beleg, ohne weiteres Kontingent; dieselbe ID mit anderem Inhalt ergibt `409 UploadRequestConflict`. Für jeden neuen Beleg eine neue ID verwenden. Ist das Belegkontingent ausgeschöpft, wird der Beleg trotzdem gespeichert (`uploadDocument.ocrStatus` = `quota_paused`); dann keinen weiteren Upload mit neuer ID starten. Benötigt einen Schlüssel mit der Berechtigung `upload`.