bimetricsEntwickler

Endpunkte

Alle Endpunkte der bimetrics API mit Parametern, Antworten und Playground.

Als Markdown ansehen

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

EndpunktBeschreibungBerechtigung
POST /api/document/Beleg hochladenupload
POST /api/document/bulk/categoryKategorie für mehrere Belege setzendocuments:write
POST /api/document/bulk/cost-centerKostenstelle für mehrere Belege setzendocuments:write
POST /api/document/bulk/counterpartyKontakt für mehrere Belege setzendocuments:write
POST /api/document/bulk/kindBelegtyp für mehrere Belege setzendocuments:write
GET /api/document/duplicatesDuplikate lesenread
POST /api/document/duplicates/deleteDuplikate entfernendocuments:delete
POST /api/document/filterBelege suchenread
GET /api/document/{id}Beleg lesenread
PATCH /api/document/{id}Belegdaten berichtigendocuments:write
DELETE /api/document/{id}Beleg löschendocuments:delete
GET /api/document/{id}/contentOriginaldatei eines Belegs ladenread
GET /api/document/{id}/delete-previewLöschen eines Belegs prüfenread
POST /api/document/{id}/reading/retryBeleg erneut lesenupload

Kontakte

EndpunktBeschreibungBerechtigung
GET /api/address/postalOrt aus PLZ, PLZ aus Ortcontacts:read
POST /api/contact/Kontakt anlegencontacts:write
POST /api/contact/checkKontaktangaben prüfencontacts:read
POST /api/contact/filterKontakte suchencontacts:read
GET /api/contact/{id}Kontakt lesencontacts:read
PUT /api/contact/{id}Kontakt änderncontacts:write
POST /api/contact/{id}/mergeKontakt zusammenführendocuments:write
GET /api/contact/{id}/numbersUSt-IdNr. und IBAN mit den Belegen abgleichencontacts:read
POST /api/contact/{id}/numbers/confirmNummer des Kontakts bestätigencontacts:write
GET /api/contact/{id}/similarÄhnliche Kontakte lesencontacts:read

Bankkonten

EndpunktBeschreibungBerechtigung
GET /api/bankaccount/connectionsBankzugänge lesenread
POST /api/bankaccount/filterBankkonten suchenread
GET /api/bankaccount/{id}Bankkonto lesenread

Umsätze

EndpunktBeschreibungBerechtigung
POST /api/banktransaction/filterUmsätze suchenread
GET /api/banktransaction/{id}Umsatz lesenread

Buchhaltung

EndpunktBeschreibungBerechtigung
GET /api/accounting/accounts/Bebuchte Konten auflistenread
GET /api/accounting/accounts/labels/Kontenbezeichnungen auflistenread
POST /api/accounting/booking/filterBuchungen suchenread
GET /api/accounting/booking/{id}Buchung lesenread
GET /api/category/Kategorien auflistenread
GET /api/export/datev/addendaNachträge in schon exportierten Monatenread
GET /api/export/datev/cash-basisZahlungen vor dem DATEV-Export prüfen (Ist-Versteuerung)read

Tarif

EndpunktBeschreibungBerechtigung
GET /api/entitlement/Tarif und Kontingent lesenread

Zu erledigen

EndpunktBeschreibungBerechtigung
GET /api/home/tasks„Zu erledigen“ lesenread

Layouts

EndpunktBeschreibungBerechtigung
GET /api/layoutsLayouts lesensales:read
POST /api/layoutsLayout anlegenlayout:write
PUT /api/layouts/assignmentsLayouts zuweisenlayout:write
GET /api/layouts/catalogErlaubte Werte lesensales:read
POST /api/layouts/previewVorschau rendernsales:read
POST /api/layouts/thumbnailsMiniaturen rendernsales:read
POST /api/layouts/versions/{id}/restoreVersion wiederherstellenlayout:write
GET /api/layouts/{id}Layout lesensales:read
PATCH /api/layouts/{id}Layout ändernlayout:write
POST /api/layouts/{id}/archiveLayout archivierenlayout:write
POST /api/layouts/{id}/duplicateLayout kopierenlayout:write
POST /api/layouts/{id}/unarchiveLayout zurückholenlayout:write
GET /api/layouts/{id}/versionsVersionen lesensales:read

Logo

EndpunktBeschreibungBerechtigung
DELETE /api/company/logoRechnungslogo löschenlayout:write
GET /api/company/logosLogo lesenread
PUT /api/company/logos/appApp-Zeichen hochladenlayout:write
DELETE /api/company/logos/appApp-Zeichen löschenlayout:write
POST /api/company/logos/fix/{id}/applyVorschlag übernehmenlayout:write
POST /api/company/logos/fix/{id}/dismissVorschlag verwerfenlayout:write
PUT /api/company/logos/invoiceRechnungslogo hochladenlayout:write
POST /api/company/logos/invoice/fix„Mach es passend“layout:write
POST /api/company/logos/invoice/originalOriginal zurückholenlayout:write

Versand per E-Mail

EndpunktBeschreibungBerechtigung
POST /api/document-mail/attachmentsDatei für eine Mail hochladenmail:send
POST /api/document-mail/previewMail vorbereitensales:read
POST /api/document-mail/sendPer E-Mail sendenmail:send

Vorlagen und Dauerbuchungen

EndpunktBeschreibungBerechtigung
POST /api/document/collection/contract/Dauerbuchung anlegencollections:write
POST /api/document/collection/contract/filterDauerbuchungen suchenread
POST /api/document/collection/contract/previewÄnderung einer Dauerbuchung prüfencollections:write
GET /api/document/collection/contract/{id}Dauerbuchung lesenread
PUT /api/document/collection/contract/{id}Dauerbuchung änderncollections:write
DELETE /api/document/collection/contract/{id}Dauerbuchung löschencollections:write
GET /api/document/collection/contract/{id}/delete-previewLöschen einer Dauerbuchung prüfenread
GET /api/document/collection/contract/{id}/document/Belege einer Dauerbuchung lesenread
POST /api/document/collection/series/Buchungsvorlage anlegencollections:write
GET /api/document/collection/series/{id}Buchungsvorlage lesenread
PUT /api/document/collection/series/{id}Buchungsvorlage änderncollections:write
DELETE /api/document/collection/series/{id}Buchungsvorlage löschencollections:write
GET /api/document/collection/series/{id}/document/Belege einer Buchungsvorlage lesenread

Belegpostfach

EndpunktBeschreibungBerechtigung
GET /api/email/inbox/Adresse des Belegpostfachs leseninbox:read
POST /api/email/inbox/item/Mails sucheninbox:read
GET /api/email/inbox/item/{id}Mail leseninbox:read
POST /api/email/inbox/item/{id}/archiveMail unter „Erledigt“ ablegeninbox:write
POST /api/email/inbox/item/{id}/attachment/{aid}/importAnhang als Beleg übernehmeninbox:write
GET /api/email/inbox/item/{id}/attachment/{aid}/previewSeite eines Anhangs anseheninbox:read
POST /api/email/inbox/item/{id}/unarchiveMail zurückholeninbox:write

Kontoauszüge

EndpunktBeschreibungBerechtigung
GET /api/bankstatement/accountsKonten ohne Bankverbindung lesenread
POST /api/bankstatement/applyKontoauszug übernehmenstatements:import
GET /api/bankstatement/configGrenzen lesenread
GET /api/bankstatement/datev-checkImporte vor dem ersten DATEV-Export prüfenread
GET /api/bankstatement/importsLaufende Importe lesenread
GET /api/bankstatement/imports/{id}Import lesenread
GET /api/bankstatement/imports/{id}/fileOriginaldatei eines Imports ladenread
POST /api/bankstatement/imports/{id}/retryImport wiederholenstatements:import
POST /api/bankstatement/inspectKontoauszug ansehenstatements:import
POST /api/bankstatement/previewVorschau eines Kontoauszugsstatements:import
POST /api/bankstatement/unreadNicht gelesene Zeilen ladenstatements:import
POST /api/bankstatement/uploadKontoauszug hochladenstatements:import

Kostenstellen

EndpunktBeschreibungBerechtigung
GET /api/cost-centersKostenstellen lesenread
POST /api/cost-centersKostenstelle oder Verteilung anlegencompany:write
PUT /api/cost-centers/{id}Kostenstelle oder Verteilung änderncompany:write
POST /api/cost-centers/{id}/archiveKostenstelle oder Verteilung archivierencompany:write
POST /api/cost-centers/{id}/unarchiveKostenstelle oder Verteilung zurückholencompany:write

Firma

EndpunktBeschreibungBerechtigung
GET /api/company/Firma lesenread
PATCH /api/company/Firmendaten änderncompany:write

Forderungen und Mahnungen

EndpunktBeschreibungBerechtigung
GET /api/receivable/Forderungsstände lesensales:read
GET /api/receivable/{id}Aktuellen Forderungsstand einer Rechnung lesensales:read
PUT /api/receivable/{id}/reminder-holdMahnsperre setzeninvoices:draft
DELETE /api/receivable/{id}/reminder-holdMahnsperre aufhebeninvoices:draft
GET /api/receivable/{id}/reminder-previewNächste Mahnung einer Rechnung als PDF ansehensales:read
POST /api/receivable/{id}/retention-releaseSicherheitseinbehalt jetzt fällig stelleninvoices:draft
GET /api/reminder/Mahnungen und Entwürfe suchensales:read
POST /api/reminder/Mahnungsentwurf erstelleninvoices:draft
POST /api/reminder/bulkMehrere Rechnungen auf einmal mahneninvoices:draft
GET /api/reminder/pdfsMehrere Mahnungs-PDFs als ZIP ladensales:read
GET /api/reminder/settingsFrist, Text und Gebühren der Mahnstufen lesensales:read
PUT /api/reminder/settings/chargesVerzugszinsen und Pauschale ein- oder ausschalteninvoices:draft
PUT /api/reminder/settings/{level}Frist, Text und Mahngebühr einer Mahnstufe änderninvoices:draft
POST /api/reminder/settings/{level}/previewMahnstufe als PDF ansehensales:read
GET /api/reminder/{id}Mahnung lesensales:read
PUT /api/reminder/{id}Offenen Mahnungsentwurf änderninvoices:draft
DELETE /api/reminder/{id}Offenen Mahnungsentwurf löscheninvoices:draft
GET /api/reminder/{id}/contentMahnungs-PDF ladensales:read
POST /api/reminder/{id}/external-sendExtern erfolgten Versand dokumentiereninvoices:draft
POST /api/reminder/{id}/issueGeprüfte Mahnung ausstelleninvoices:draft
POST /api/reminder/{id}/previewMahnungsentwurf prüfen oder Original ansehensales:read
POST /api/reminder/{id}/withdrawAusgestellte Mahnung zurückzieheninvoices:draft

Wiederkehrende Rechnungen

EndpunktBeschreibungBerechtigung
GET /api/recurringinvoice/Serienvorlagen lesensales:read
POST /api/recurringinvoice/Serienvorlage anlegeninvoices:draft
GET /api/recurringinvoice/{id}Serienvorlage und Periodenverlauf lesensales:read
PUT /api/recurringinvoice/{id}Serienvorlage änderninvoices:draft
POST /api/recurringinvoice/{id}/activateSerienvorlage aktiviereninvoices:draft
POST /api/recurringinvoice/{id}/endSerienvorlage dauerhaft beendeninvoices:draft
GET /api/recurringinvoice/{id}/next-datesNächste Serientermine prüfensales:read
POST /api/recurringinvoice/{id}/pauseSerienvorlage pausiereninvoices:draft
POST /api/recurringinvoice/{id}/prepareGenau eine Rechnungsperiode erzeugeninvoices:draft

Ausgangsrechnungen

EndpunktBeschreibungBerechtigung
POST /api/draft/Rechnungs- oder Angebotsentwurf anlegeninvoices:draft
POST /api/draft/filterRechnungsentwürfe suchensales:read
POST /api/draft/list/countRechnungen oder Angebote je Reiter zählensales:read
GET /api/draft/{id}Rechnungsentwurf lesensales:read
PUT /api/draft/{id}Rechnungs- oder AB-Entwurf änderninvoices:draft
DELETE /api/draft/{id}Offenen Entwurf löscheninvoices:draft
POST /api/draft/{id}/cancelAusgangsrechnung vollständig storniereninvoices:finalize
GET /api/draft/{id}/contentVertriebsdokument als PDF ladensales:read
POST /api/draft/{id}/copyRechnung oder Angebot dupliziereninvoices:draft
POST /api/draft/{id}/correctionRechnungskorrektur als Entwurf erstelleninvoices:draft
PUT /api/draft/{id}/correctionKorrekturentwurf änderninvoices:draft
GET /api/draft/{id}/correction-capacityVerfügbare Rechnungskorrektur je Position lesensales:read
POST /api/draft/{id}/correction/cancelAusgestellte Rechnungskorrektur vollständig aufhebeninvoices:finalize
POST /api/draft/{id}/deriveFolgedokument aus gewählter Quelle erstelleninvoices:draft
GET /api/draft/{id}/einvoice-xmlAusgestellte E-Rechnung ladensales:read
PUT /api/draft/{id}/finalizeRechnung, Korrektur, Angebot oder Auftragsbestätigung ausstelleninvoices:finalize
POST /api/draft/{id}/proposal-outcomeAngebot annehmen, ablehnen oder zurücksetzeninvoices:draft
POST /api/draft/{id}/tax-caseGespeicherten Rechnungsentwurf prüfeninvoices:draft
DELETE /api/orderconfirmation/draft/{id}Offenen AB-Entwurf verwerfeninvoices:draft
GET /api/orderconfirmation/{id}Ausgestellte Auftragsbestätigung lesensales:read
GET /api/tax-case/exempt-reasonsBefreiungsgründe auflistensales:read

Zuordnungen

EndpunktBeschreibungBerechtigung
POST /api/document/collection/series/filterBuchungsvorlagen suchenread
POST /api/match/Belege und Umsätze zuordnenmatching:write
POST /api/match/correction-settlement/offsetKorrekturguthaben mit anderer Rechnung verrechnenmatching:write
POST /api/match/correction-settlement/refundBereits erfolgte Rückzahlung erfassenmatching:write
POST /api/match/correction-settlement/reverseErfasste Rückzahlung oder Verrechnung zurücknehmenmatching:write
GET /api/match/correction-settlement/{correctionDocumentId}Erstattungsfähiges Guthaben einer Rechnungskorrektur lesensales:read
GET /api/match/correction-settlement/{correctionDocumentId}/targetsGeeignete Rechnungen für eine Verrechnung suchensales:read
POST /api/match/dismissZuordnungsvorschlag ausblendenmatching:write
DELETE /api/match/dismiss/{id}Ausgeblendeten Vorschlag zurückholenmatching:write
POST /api/match/paymentBereits erfolgte Zahlung erfassenmatching:write
POST /api/match/payment/bulkZahlungen für mehrere Belege eintragenmatching:write
GET /api/match/payment/privatePrivat bezahlt: Stand der Firma lesenread
POST /api/match/payment/reverseErfasste Zahlung zurücknehmenmatching:write
POST /api/match/suggestionsZuordnungsvorschläge lesenread
POST /api/match/util/amountopenOffenen Zuordnungsbetrag berechnenread
GET /api/match/{id}Zuordnung lesenread
DELETE /api/match/{id}Zuordnung aufhebenmatching:write
POST /api/match/{id}/cash-discountOffenen Betrag einer Zuordnung als Skonto ausgleichenmatching:write
GET /api/match/{id}/cash-discount-previewSkonto einer Zuordnung prüfenread
GET /api/match/{id}/delete-previewAufheben einer Zuordnung prüfenread
POST /api/match/{id}/euro-amountEuro-Betrag aus der Zahlung übernehmenmatching:write
GET /api/match/{id}/euro-amount-previewEuro-Betrag aus der Zahlung prüfenread
POST /api/match/{id}/extendZuordnung erweiternmatching:write
POST /api/match/{id}/reminder-chargesMehrbetrag einer Zuordnung als Mahnkosten und Zinsen buchenmatching:write
GET /api/match/{id}/reminder-charges-previewMahnkosten einer Zuordnung prüfenread

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 Header X-API-KEY lässt der Browser nicht zu, weil app.bimetrics.de ihn 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.

Sicherheit und Widerruf

Worauf du bei der Freigabe achtest, was mit den Daten passiert und wie du eine MCP-Verbindung beendest.

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, beides bindend; bei `auto[]` entscheidet die Erkennung mit den Daten deiner Firma. Kann sie nicht sicher entscheiden, bekommt der Beleg „Belegtyp prüfen“ (`kindReview`) und wird nicht gebucht, bis du den Belegtyp wählst. 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`.

Auf dieser Seite

Playground