# Endpunkte (https://developer.bimetrics.de/reference)

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

Die Referenz entsteht aus der [OpenAPI-Beschreibung](https://app.bimetrics.de/api/openapi.json) des Backends. Alle Pfade beginnen mit `https://app.bimetrics.de/api/`, authentifiziert wird mit `Authorization: Bearer bm_…` (siehe [Authentifizierung](/authentication)).

### Belege

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/document/`](https://developer.bimetrics.de/reference/documents/upload-document.md) | Beleg hochladen | upload |
| [`POST /api/document/bulk/category`](https://developer.bimetrics.de/reference/documents/set-document-category-in-bulk.md) | Kategorie für mehrere Belege setzen | documents:write |
| [`POST /api/document/bulk/cost-center`](https://developer.bimetrics.de/reference/documents/set-document-cost-center-in-bulk.md) | Kostenstelle für mehrere Belege setzen | documents:write |
| [`POST /api/document/bulk/counterparty`](https://developer.bimetrics.de/reference/documents/set-document-contact-in-bulk.md) | Kontakt für mehrere Belege setzen | documents:write |
| [`POST /api/document/bulk/kind`](https://developer.bimetrics.de/reference/documents/set-document-kind-in-bulk.md) | Belegtyp für mehrere Belege setzen | documents:write |
| [`GET /api/document/duplicates`](https://developer.bimetrics.de/reference/documents/list-document-duplicates.md) | Duplikate lesen | read |
| [`POST /api/document/duplicates/delete`](https://developer.bimetrics.de/reference/documents/delete-document-duplicates.md) | Duplikate entfernen | documents:delete |
| [`POST /api/document/filter`](https://developer.bimetrics.de/reference/documents/filter-documents.md) | Belege suchen | read |
| [`GET /api/document/{id}`](https://developer.bimetrics.de/reference/documents/get-document.md) | Beleg lesen | read |
| [`PATCH /api/document/{id}`](https://developer.bimetrics.de/reference/documents/patch-document.md) | Belegdaten berichtigen | documents:write |
| [`DELETE /api/document/{id}`](https://developer.bimetrics.de/reference/documents/delete-document.md) | Beleg löschen | documents:delete |
| [`GET /api/document/{id}/content`](https://developer.bimetrics.de/reference/documents/get-document-content.md) | Originaldatei eines Belegs laden | read |
| [`GET /api/document/{id}/delete-preview`](https://developer.bimetrics.de/reference/documents/preview-document-deletion.md) | Löschen eines Belegs prüfen | read |
| [`GET /api/document/{id}/monthly-rate`](https://developer.bimetrics.de/reference/documents/preview-document-monthly-rate.md) | Umrechnung zum Monatskurs prüfen | read |
| [`POST /api/document/{id}/reading/retry`](https://developer.bimetrics.de/reference/documents/retry-document-reading.md) | Beleg erneut lesen | upload |

### Kontakte

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/address/postal`](https://developer.bimetrics.de/reference/contacts/lookup-postal-code.md) | Ort aus PLZ, PLZ aus Ort | contacts:read |
| [`GET /api/address/streets`](https://developer.bimetrics.de/reference/contacts/suggest-streets.md) | Straßenvorschläge beim Tippen | contacts:read |
| [`POST /api/contact/`](https://developer.bimetrics.de/reference/contacts/create-contact.md) | Kontakt anlegen | contacts:write |
| [`POST /api/contact/check`](https://developer.bimetrics.de/reference/contacts/check-contact.md) | Kontaktangaben prüfen | contacts:read |
| [`POST /api/contact/filter`](https://developer.bimetrics.de/reference/contacts/filter-contacts.md) | Kontakte suchen | contacts:read |
| [`GET /api/contact/{id}`](https://developer.bimetrics.de/reference/contacts/get-contact.md) | Kontakt lesen | contacts:read |
| [`PUT /api/contact/{id}`](https://developer.bimetrics.de/reference/contacts/update-contact.md) | Kontakt ändern | contacts:write |
| [`POST /api/contact/{id}/merge`](https://developer.bimetrics.de/reference/contacts/merge-contact.md) | Kontakt zusammenführen | documents:write |
| [`GET /api/contact/{id}/numbers`](https://developer.bimetrics.de/reference/contacts/get-contact-numbers.md) | USt-IdNr. und IBAN mit den Belegen abgleichen | contacts:read |
| [`POST /api/contact/{id}/numbers/confirm`](https://developer.bimetrics.de/reference/contacts/confirm-contact-number.md) | Nummer des Kontakts bestätigen | contacts:write |
| [`GET /api/contact/{id}/similar`](https://developer.bimetrics.de/reference/contacts/get-similar-contacts.md) | Ähnliche Kontakte lesen | contacts:read |
| [`POST /api/contact/{id}/similar/dismiss`](https://developer.bimetrics.de/reference/contacts/dismiss-similar-contact.md) | Ähnlichen Kontakt als andere Firma markieren | contacts:write |

### Bankkonten

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/bankaccount/connections`](https://developer.bimetrics.de/reference/bank-accounts/list-bank-connections.md) | Bankzugänge lesen | read |
| [`POST /api/bankaccount/filter`](https://developer.bimetrics.de/reference/bank-accounts/filter-bank-accounts.md) | Bankkonten suchen | read |
| [`GET /api/bankaccount/{id}`](https://developer.bimetrics.de/reference/bank-accounts/get-bank-account.md) | Bankkonto lesen | read |

### Umsätze

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/banktransaction/filter`](https://developer.bimetrics.de/reference/bank-transactions/filter-bank-transactions.md) | Umsätze suchen | read |
| [`GET /api/banktransaction/{id}`](https://developer.bimetrics.de/reference/bank-transactions/get-bank-transaction.md) | Umsatz lesen | read |

### Buchhaltung

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/accounting/accounts/`](https://developer.bimetrics.de/reference/accounting/list-used-accounts.md) | Bebuchte Konten auflisten | read |
| [`GET /api/accounting/accounts/labels/`](https://developer.bimetrics.de/reference/accounting/list-account-labels.md) | Kontenbezeichnungen auflisten | read |
| [`POST /api/accounting/booking/filter`](https://developer.bimetrics.de/reference/accounting/filter-bookings.md) | Buchungen suchen | read |
| [`GET /api/accounting/booking/{id}`](https://developer.bimetrics.de/reference/accounting/get-booking.md) | Buchung lesen | read |
| [`GET /api/category/`](https://developer.bimetrics.de/reference/accounting/list-categories.md) | Kategorien auflisten | read |
| [`GET /api/export/datev/addenda`](https://developer.bimetrics.de/reference/accounting/check-datev-addenda.md) | Nachträge in schon exportierten Monaten | read |
| [`GET /api/export/datev/cash-basis`](https://developer.bimetrics.de/reference/accounting/check-datev-cash-basis.md) | Zahlungen vor dem DATEV-Export prüfen (Ist-Versteuerung) | read |
| [`POST /api/export/datev/job`](https://developer.bimetrics.de/reference/accounting/start-datev-export.md) | DATEV-Export starten und Buchungen festschreiben | datev:export |
| [`POST /api/export/datev/open`](https://developer.bimetrics.de/reference/accounting/count-datev-open-bookings.md) | Offene Buchungen vor dem DATEV-Export zählen | datev:export |
| [`GET /api/export/datev/reserved-reversals`](https://developer.bimetrics.de/reference/accounting/check-datev-reserved-reversals.md) | Stornos auf Konten, die DATEV nicht mehr annimmt | read |
| [`GET /api/export/jobs/{id}`](https://developer.bimetrics.de/reference/accounting/get-export-job.md) | Stand eines DATEV-Exports abrufen | datev:export |
| [`POST /api/export/jobs/{id}/cancel`](https://developer.bimetrics.de/reference/accounting/cancel-export-job.md) | Wartenden DATEV-Export abbrechen | datev:export |
| [`POST /api/export/jobs/{id}/files/{name}/ticket`](https://developer.bimetrics.de/reference/accounting/issue-export-file-ticket.md) | Datei eines DATEV-Exports laden | datev:export |

### Tarif

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/entitlement/`](https://developer.bimetrics.de/reference/plan/get-entitlement.md) | Tarif und Kontingent lesen | read |

### Zu erledigen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/home/tasks`](https://developer.bimetrics.de/reference/tasks/get-tasks.md) | „Zu erledigen“ lesen | read |

### Layouts

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/layouts`](https://developer.bimetrics.de/reference/layouts/list-layouts.md) | Layouts lesen | sales:read |
| [`POST /api/layouts`](https://developer.bimetrics.de/reference/layouts/create-layout.md) | Layout anlegen | layout:write |
| [`PUT /api/layouts/assignments`](https://developer.bimetrics.de/reference/layouts/assign-layouts.md) | Layouts zuweisen | layout:write |
| [`GET /api/layouts/catalog`](https://developer.bimetrics.de/reference/layouts/get-layout-catalog.md) | Erlaubte Werte lesen | sales:read |
| [`POST /api/layouts/preview`](https://developer.bimetrics.de/reference/layouts/preview-layout.md) | Vorschau rendern | sales:read |
| [`POST /api/layouts/thumbnails`](https://developer.bimetrics.de/reference/layouts/render-layout-thumbnails.md) | Miniaturen rendern | sales:read |
| [`POST /api/layouts/versions/{id}/restore`](https://developer.bimetrics.de/reference/layouts/restore-layout-version.md) | Version wiederherstellen | layout:write |
| [`GET /api/layouts/{id}`](https://developer.bimetrics.de/reference/layouts/get-layout.md) | Layout lesen | sales:read |
| [`PATCH /api/layouts/{id}`](https://developer.bimetrics.de/reference/layouts/change-layout.md) | Layout ändern | layout:write |
| [`POST /api/layouts/{id}/archive`](https://developer.bimetrics.de/reference/layouts/archive-layout.md) | Layout archivieren | layout:write |
| [`POST /api/layouts/{id}/duplicate`](https://developer.bimetrics.de/reference/layouts/duplicate-layout.md) | Layout kopieren | layout:write |
| [`POST /api/layouts/{id}/unarchive`](https://developer.bimetrics.de/reference/layouts/unarchive-layout.md) | Layout zurückholen | layout:write |
| [`GET /api/layouts/{id}/versions`](https://developer.bimetrics.de/reference/layouts/list-layout-versions.md) | Versionen lesen | sales:read |

### Logo

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`DELETE /api/company/logo`](https://developer.bimetrics.de/reference/logo/delete-invoice-logo.md) | Rechnungslogo löschen | layout:write |
| [`GET /api/company/logos`](https://developer.bimetrics.de/reference/logo/get-logos.md) | Logo lesen | read |
| [`PUT /api/company/logos/app`](https://developer.bimetrics.de/reference/logo/upload-app-logo.md) | App-Zeichen hochladen | layout:write |
| [`DELETE /api/company/logos/app`](https://developer.bimetrics.de/reference/logo/delete-app-logo.md) | App-Zeichen löschen | layout:write |
| [`POST /api/company/logos/fix/{id}/apply`](https://developer.bimetrics.de/reference/logo/apply-logo-fix.md) | Vorschlag übernehmen | layout:write |
| [`POST /api/company/logos/fix/{id}/dismiss`](https://developer.bimetrics.de/reference/logo/dismiss-logo-fix.md) | Vorschlag verwerfen | layout:write |
| [`PUT /api/company/logos/invoice`](https://developer.bimetrics.de/reference/logo/upload-invoice-logo.md) | Rechnungslogo hochladen | layout:write |
| [`POST /api/company/logos/invoice/fix`](https://developer.bimetrics.de/reference/logo/fix-invoice-logo.md) | „Mach es passend“ | layout:write |
| [`POST /api/company/logos/invoice/original`](https://developer.bimetrics.de/reference/logo/restore-invoice-logo.md) | Original zurückholen | layout:write |

### Versand per E-Mail

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/document-mail/attachments`](https://developer.bimetrics.de/reference/document-mail/upload-mail-attachment.md) | Datei für eine Mail hochladen | mail:send |
| [`POST /api/document-mail/preview`](https://developer.bimetrics.de/reference/document-mail/preview-document-mail.md) | Mail vorbereiten | sales:read |
| [`POST /api/document-mail/send`](https://developer.bimetrics.de/reference/document-mail/send-document-mail.md) | Per E-Mail senden | mail:send |

### Vorlagen und Dauerbuchungen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/document/collection/contract/`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/create-document-contract.md) | Dauerbuchung anlegen | collections:write |
| [`POST /api/document/collection/contract/filter`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/filter-document-contracts.md) | Dauerbuchungen suchen | read |
| [`POST /api/document/collection/contract/preview`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/preview-document-contract.md) | Änderung einer Dauerbuchung prüfen | collections:write |
| [`GET /api/document/collection/contract/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/get-document-contract.md) | Dauerbuchung lesen | read |
| [`PUT /api/document/collection/contract/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/update-document-contract.md) | Dauerbuchung ändern | collections:write |
| [`DELETE /api/document/collection/contract/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/delete-document-contract.md) | Dauerbuchung löschen | collections:write |
| [`GET /api/document/collection/contract/{id}/delete-preview`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/preview-document-contract-deletion.md) | Löschen einer Dauerbuchung prüfen | read |
| [`GET /api/document/collection/contract/{id}/document/`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/list-document-contract-documents.md) | Belege einer Dauerbuchung lesen | read |
| [`POST /api/document/collection/series/`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/create-document-series.md) | Buchungsvorlage anlegen | collections:write |
| [`GET /api/document/collection/series/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/get-document-series.md) | Buchungsvorlage lesen | read |
| [`PUT /api/document/collection/series/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/update-document-series.md) | Buchungsvorlage ändern | collections:write |
| [`DELETE /api/document/collection/series/{id}`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/delete-document-series.md) | Buchungsvorlage löschen | collections:write |
| [`GET /api/document/collection/series/{id}/document/`](https://developer.bimetrics.de/reference/templates-and-recurring-bookings/list-document-series-documents.md) | Belege einer Buchungsvorlage lesen | read |

### Belegpostfach

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/email/inbox/`](https://developer.bimetrics.de/reference/inbox/get-email-inbox.md) | Adresse des Belegpostfachs lesen | inbox:read |
| [`POST /api/email/inbox/item/`](https://developer.bimetrics.de/reference/inbox/filter-email-inbox-items.md) | Mails suchen | inbox:read |
| [`GET /api/email/inbox/item/{id}`](https://developer.bimetrics.de/reference/inbox/get-email-inbox-item.md) | Mail lesen | inbox:read |
| [`POST /api/email/inbox/item/{id}/archive`](https://developer.bimetrics.de/reference/inbox/archive-email-inbox-item.md) | Mail unter „Erledigt“ ablegen | inbox:write |
| [`POST /api/email/inbox/item/{id}/attachment/{aid}/import`](https://developer.bimetrics.de/reference/inbox/import-email-inbox-attachment.md) | Anhang als Beleg übernehmen | inbox:write |
| [`GET /api/email/inbox/item/{id}/attachment/{aid}/preview`](https://developer.bimetrics.de/reference/inbox/preview-email-inbox-attachment.md) | Seite eines Anhangs ansehen | inbox:read |
| [`POST /api/email/inbox/item/{id}/unarchive`](https://developer.bimetrics.de/reference/inbox/unarchive-email-inbox-item.md) | Mail zurückholen | inbox:write |

### Kontoauszüge

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/bankstatement/accounts`](https://developer.bimetrics.de/reference/bank-statements/list-statement-accounts.md) | Konten ohne Bankverbindung lesen | read |
| [`POST /api/bankstatement/apply`](https://developer.bimetrics.de/reference/bank-statements/apply-statement.md) | Kontoauszug übernehmen | statements:import |
| [`GET /api/bankstatement/config`](https://developer.bimetrics.de/reference/bank-statements/get-statement-config.md) | Grenzen lesen | read |
| [`GET /api/bankstatement/datev-check`](https://developer.bimetrics.de/reference/bank-statements/check-statement-datev.md) | Importe vor dem ersten DATEV-Export prüfen | read |
| [`GET /api/bankstatement/imports`](https://developer.bimetrics.de/reference/bank-statements/list-statement-imports.md) | Laufende Importe lesen | read |
| [`GET /api/bankstatement/imports/{id}`](https://developer.bimetrics.de/reference/bank-statements/get-statement-import.md) | Import lesen | read |
| [`GET /api/bankstatement/imports/{id}/file`](https://developer.bimetrics.de/reference/bank-statements/get-statement-import-file.md) | Originaldatei eines Imports laden | read |
| [`POST /api/bankstatement/imports/{id}/retry`](https://developer.bimetrics.de/reference/bank-statements/retry-statement-import.md) | Import wiederholen | statements:import |
| [`POST /api/bankstatement/inspect`](https://developer.bimetrics.de/reference/bank-statements/inspect-statement.md) | Kontoauszug ansehen | statements:import |
| [`POST /api/bankstatement/preview`](https://developer.bimetrics.de/reference/bank-statements/preview-statement.md) | Vorschau eines Kontoauszugs | statements:import |
| [`POST /api/bankstatement/unread`](https://developer.bimetrics.de/reference/bank-statements/download-statement-unread.md) | Nicht gelesene Zeilen laden | statements:import |
| [`POST /api/bankstatement/upload`](https://developer.bimetrics.de/reference/bank-statements/upload-statement.md) | Kontoauszug hochladen | statements:import |

### Kassenbuch

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/cash-book-entries/{id}/bank-transaction`](https://developer.bimetrics.de/reference/cash-book/link-cash-book-bank-transaction.md) | Bankumsatz einer Buchung Bank ↔ Kasse zuordnen | matching:write |
| [`GET /api/cash-book-entries/{id}/bank-transactions`](https://developer.bimetrics.de/reference/cash-book/get-cash-book-bank-candidates.md) | Passende Bankumsätze zu Bank ↔ Kasse | read |
| [`POST /api/cash-book-entries/{id}/reverse`](https://developer.bimetrics.de/reference/cash-book/reverse-cash-book-entry.md) | Kassenbuch-Eintrag stornieren | matching:write |
| [`GET /api/cash-books`](https://developer.bimetrics.de/reference/cash-book/list-cash-books.md) | Kassenbücher lesen | read |
| [`POST /api/cash-books`](https://developer.bimetrics.de/reference/cash-book/create-cash-book.md) | Kassenbuch anlegen | company:write |
| [`PATCH /api/cash-books/{id}`](https://developer.bimetrics.de/reference/cash-book/update-cash-book.md) | Kassenbuch umbenennen | company:write |
| [`POST /api/cash-books/{id}/archive`](https://developer.bimetrics.de/reference/cash-book/archive-cash-book.md) | Kassenbuch stilllegen | company:write |
| [`GET /api/cash-books/{id}/audit-export`](https://developer.bimetrics.de/reference/cash-book/download-cash-book-audit-export.md) | Prüfungsexport eines Kassenbuchs | read |
| [`POST /api/cash-books/{id}/counts`](https://developer.bimetrics.de/reference/cash-book/record-cash-count.md) | Kasse zählen | matching:write |
| [`POST /api/cash-books/{id}/counts/preview`](https://developer.bimetrics.de/reference/cash-book/preview-cash-count.md) | Kassenzählung prüfen | read |
| [`GET /api/cash-books/{id}/entries`](https://developer.bimetrics.de/reference/cash-book/get-cash-book-month.md) | Monat eines Kassenbuchs lesen | read |
| [`POST /api/cash-books/{id}/entries`](https://developer.bimetrics.de/reference/cash-book/create-cash-book-entries.md) | Kassenbuch-Einträge buchen | matching:write |
| [`POST /api/cash-books/{id}/entries/preview`](https://developer.bimetrics.de/reference/cash-book/preview-cash-book-entries.md) | Kassenbuch-Einträge prüfen | read |
| [`POST /api/cash-books/{id}/months/{month}/close`](https://developer.bimetrics.de/reference/cash-book/close-cash-month.md) | Monat abschließen | matching:write |
| [`POST /api/cash-books/{id}/months/{month}/close/preview`](https://developer.bimetrics.de/reference/cash-book/preview-cash-month-close.md) | Monatsabschluss prüfen | read |
| [`GET /api/cash-books/{id}/pdf`](https://developer.bimetrics.de/reference/cash-book/download-cash-book-pdf.md) | Monat eines Kassenbuchs als PDF | read |
| [`GET /api/cash-books/{id}/pdf/pages`](https://developer.bimetrics.de/reference/cash-book/get-cash-book-pdfpages.md) | Monat eines Kassenbuchs als Seitenbilder | read |
| [`GET /api/settings/cash-book`](https://developer.bimetrics.de/reference/cash-book/get-cash-book-settings.md) | Kassenbuch-Einstellung lesen | read |
| [`PUT /api/settings/cash-book`](https://developer.bimetrics.de/reference/cash-book/set-cash-book-enabled.md) | Kassenbuch ein- oder ausschalten | company:write |

### Kostenstellen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/cost-centers`](https://developer.bimetrics.de/reference/cost-centers/list-cost-centers.md) | Kostenstellen lesen | read |
| [`POST /api/cost-centers`](https://developer.bimetrics.de/reference/cost-centers/create-cost-center.md) | Kostenstelle oder Verteilung anlegen | company:write |
| [`GET /api/cost-centers/documents`](https://developer.bimetrics.de/reference/cost-centers/describe-cost-center-documents.md) | Belege für die Wahl einer Kostenstelle lesen | read |
| [`GET /api/cost-centers/report`](https://developer.bimetrics.de/reference/cost-centers/get-cost-center-report.md) | Auswertung der Kostenstellen lesen | read |
| [`PUT /api/cost-centers/{id}`](https://developer.bimetrics.de/reference/cost-centers/update-cost-center.md) | Kostenstelle oder Verteilung ändern | company:write |
| [`POST /api/cost-centers/{id}/archive`](https://developer.bimetrics.de/reference/cost-centers/archive-cost-center.md) | Kostenstelle oder Verteilung archivieren | company:write |
| [`POST /api/cost-centers/{id}/unarchive`](https://developer.bimetrics.de/reference/cost-centers/unarchive-cost-center.md) | Kostenstelle oder Verteilung zurückholen | company:write |

### Firma

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/company/`](https://developer.bimetrics.de/reference/company/get-company.md) | Firma lesen | read |
| [`PATCH /api/company/`](https://developer.bimetrics.de/reference/company/update-company.md) | Firmendaten ändern | company:write |

### Forderungen und Mahnungen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/receivable/`](https://developer.bimetrics.de/reference/receivables/list-receivables.md) | Forderungsstände lesen | sales:read |
| [`GET /api/receivable/{id}`](https://developer.bimetrics.de/reference/receivables/get-receivable.md) | Aktuellen Forderungsstand einer Rechnung lesen | sales:read |
| [`PUT /api/receivable/{id}/reminder-hold`](https://developer.bimetrics.de/reference/receivables/set-reminder-hold.md) | Mahnsperre setzen | invoices:draft |
| [`DELETE /api/receivable/{id}/reminder-hold`](https://developer.bimetrics.de/reference/receivables/clear-reminder-hold.md) | Mahnsperre aufheben | invoices:draft |
| [`GET /api/receivable/{id}/reminder-preview`](https://developer.bimetrics.de/reference/receivables/preview-next-reminder.md) | Nächste Mahnung einer Rechnung als PDF ansehen | sales:read |
| [`POST /api/receivable/{id}/retention-release`](https://developer.bimetrics.de/reference/receivables/release-retention.md) | Sicherheitseinbehalt jetzt fällig stellen | invoices:draft |
| [`GET /api/reminder/`](https://developer.bimetrics.de/reference/receivables/list-reminders.md) | Mahnungen und Entwürfe suchen | sales:read |
| [`POST /api/reminder/`](https://developer.bimetrics.de/reference/receivables/create-reminder.md) | Mahnungsentwurf erstellen | invoices:draft |
| [`POST /api/reminder/bulk`](https://developer.bimetrics.de/reference/receivables/run-reminders.md) | Mehrere Rechnungen auf einmal mahnen | invoices:draft |
| [`GET /api/reminder/pdfs`](https://developer.bimetrics.de/reference/receivables/download-reminder-pdfs.md) | Mehrere Mahnungs-PDFs als ZIP laden | sales:read |
| [`GET /api/reminder/settings`](https://developer.bimetrics.de/reference/receivables/get-reminder-settings.md) | Frist, Text und Gebühren der Mahnstufen lesen | sales:read |
| [`PUT /api/reminder/settings/charges`](https://developer.bimetrics.de/reference/receivables/update-reminder-charges.md) | Verzugszinsen und Pauschale ein- oder ausschalten | invoices:draft |
| [`PUT /api/reminder/settings/{level}`](https://developer.bimetrics.de/reference/receivables/update-reminder-level.md) | Frist, Text und Mahngebühr einer Mahnstufe ändern | invoices:draft |
| [`POST /api/reminder/settings/{level}/preview`](https://developer.bimetrics.de/reference/receivables/preview-reminder-level.md) | Mahnstufe als PDF ansehen | sales:read |
| [`GET /api/reminder/{id}`](https://developer.bimetrics.de/reference/receivables/get-reminder.md) | Mahnung lesen | sales:read |
| [`PUT /api/reminder/{id}`](https://developer.bimetrics.de/reference/receivables/update-reminder.md) | Offenen Mahnungsentwurf ändern | invoices:draft |
| [`DELETE /api/reminder/{id}`](https://developer.bimetrics.de/reference/receivables/delete-reminder-draft.md) | Offenen Mahnungsentwurf löschen | invoices:draft |
| [`GET /api/reminder/{id}/content`](https://developer.bimetrics.de/reference/receivables/download-reminder-pdf.md) | Mahnungs-PDF laden | sales:read |
| [`POST /api/reminder/{id}/external-send`](https://developer.bimetrics.de/reference/receivables/record-reminder-external-send.md) | Extern erfolgten Versand dokumentieren | invoices:draft |
| [`POST /api/reminder/{id}/issue`](https://developer.bimetrics.de/reference/receivables/issue-reminder.md) | Geprüfte Mahnung ausstellen | invoices:draft |
| [`POST /api/reminder/{id}/preview`](https://developer.bimetrics.de/reference/receivables/preview-reminder.md) | Mahnungsentwurf prüfen oder Original ansehen | sales:read |
| [`POST /api/reminder/{id}/withdraw`](https://developer.bimetrics.de/reference/receivables/withdraw-reminder.md) | Ausgestellte Mahnung zurückziehen | invoices:draft |

### Wiederkehrende Rechnungen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`GET /api/recurringinvoice/`](https://developer.bimetrics.de/reference/recurring-invoices/list-recurring-invoices.md) | Serienvorlagen lesen | sales:read |
| [`POST /api/recurringinvoice/`](https://developer.bimetrics.de/reference/recurring-invoices/create-recurring-invoice.md) | Serienvorlage anlegen | invoices:draft |
| [`GET /api/recurringinvoice/{id}`](https://developer.bimetrics.de/reference/recurring-invoices/get-recurring-invoice.md) | Serienvorlage und Periodenverlauf lesen | sales:read |
| [`PUT /api/recurringinvoice/{id}`](https://developer.bimetrics.de/reference/recurring-invoices/update-recurring-invoice.md) | Serienvorlage ändern | invoices:draft |
| [`POST /api/recurringinvoice/{id}/activate`](https://developer.bimetrics.de/reference/recurring-invoices/activate-recurring-invoice.md) | Serienvorlage aktivieren | invoices:draft |
| [`POST /api/recurringinvoice/{id}/end`](https://developer.bimetrics.de/reference/recurring-invoices/end-recurring-invoice.md) | Serienvorlage dauerhaft beenden | invoices:draft |
| [`GET /api/recurringinvoice/{id}/next-dates`](https://developer.bimetrics.de/reference/recurring-invoices/get-recurring-invoice-dates.md) | Nächste Serientermine prüfen | sales:read |
| [`POST /api/recurringinvoice/{id}/pause`](https://developer.bimetrics.de/reference/recurring-invoices/pause-recurring-invoice.md) | Serienvorlage pausieren | invoices:draft |
| [`POST /api/recurringinvoice/{id}/prepare`](https://developer.bimetrics.de/reference/recurring-invoices/prepare-recurring-invoice.md) | Genau eine Rechnungsperiode erzeugen | invoices:draft |

### Ausgangsrechnungen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/draft/`](https://developer.bimetrics.de/reference/sales/create-draft.md) | Rechnungs- oder Angebotsentwurf anlegen | invoices:draft |
| [`POST /api/draft/filter`](https://developer.bimetrics.de/reference/sales/filter-drafts.md) | Rechnungsentwürfe suchen | sales:read |
| [`POST /api/draft/list/count`](https://developer.bimetrics.de/reference/sales/count-drafts.md) | Rechnungen oder Angebote je Reiter zählen | sales:read |
| [`GET /api/draft/{id}`](https://developer.bimetrics.de/reference/sales/get-draft.md) | Rechnungsentwurf lesen | sales:read |
| [`PUT /api/draft/{id}`](https://developer.bimetrics.de/reference/sales/update-draft.md) | Rechnungs- oder AB-Entwurf ändern | invoices:draft |
| [`DELETE /api/draft/{id}`](https://developer.bimetrics.de/reference/sales/delete-draft.md) | Offenen Entwurf löschen | invoices:draft |
| [`POST /api/draft/{id}/cancel`](https://developer.bimetrics.de/reference/sales/cancel-invoice.md) | Ausgangsrechnung vollständig stornieren | invoices:finalize |
| [`GET /api/draft/{id}/content`](https://developer.bimetrics.de/reference/sales/download-sales-pdf.md) | Vertriebsdokument als PDF laden | sales:read |
| [`POST /api/draft/{id}/copy`](https://developer.bimetrics.de/reference/sales/copy-sales-document.md) | Rechnung oder Angebot duplizieren | invoices:draft |
| [`POST /api/draft/{id}/correction`](https://developer.bimetrics.de/reference/sales/create-invoice-correction.md) | Rechnungskorrektur als Entwurf erstellen | invoices:draft |
| [`PUT /api/draft/{id}/correction`](https://developer.bimetrics.de/reference/sales/update-invoice-correction.md) | Korrekturentwurf ändern | invoices:draft |
| [`GET /api/draft/{id}/correction-capacity`](https://developer.bimetrics.de/reference/sales/get-correction-capacity.md) | Verfügbare Rechnungskorrektur je Position lesen | sales:read |
| [`POST /api/draft/{id}/correction/cancel`](https://developer.bimetrics.de/reference/sales/cancel-invoice-correction.md) | Ausgestellte Rechnungskorrektur vollständig aufheben | invoices:finalize |
| [`POST /api/draft/{id}/derive`](https://developer.bimetrics.de/reference/sales/derive-sales-document.md) | Folgedokument aus gewählter Quelle erstellen | invoices:draft |
| [`GET /api/draft/{id}/einvoice-xml`](https://developer.bimetrics.de/reference/sales/get-issued-invoice-xml.md) | Ausgestellte E-Rechnung laden | sales:read |
| [`PUT /api/draft/{id}/finalize`](https://developer.bimetrics.de/reference/sales/finalize-draft.md) | Rechnung, Korrektur, Angebot oder Auftragsbestätigung ausstellen | invoices:finalize |
| [`POST /api/draft/{id}/proposal-outcome`](https://developer.bimetrics.de/reference/sales/set-proposal-outcome.md) | Angebot annehmen, ablehnen oder zurücksetzen | invoices:draft |
| [`POST /api/draft/{id}/tax-case`](https://developer.bimetrics.de/reference/sales/check-draft.md) | Gespeicherten Rechnungsentwurf prüfen | invoices:draft |
| [`DELETE /api/orderconfirmation/draft/{id}`](https://developer.bimetrics.de/reference/sales/delete-order-confirmation-draft.md) | Offenen AB-Entwurf verwerfen | invoices:draft |
| [`GET /api/orderconfirmation/{id}`](https://developer.bimetrics.de/reference/sales/get-order-confirmation.md) | Ausgestellte Auftragsbestätigung lesen | sales:read |
| [`GET /api/tax-case/exempt-reasons`](https://developer.bimetrics.de/reference/sales/list-exempt-reasons.md) | Befreiungsgründe auflisten | sales:read |

### Zuordnungen

| Endpunkt | Beschreibung | Berechtigung |
| --- | --- | --- |
| [`POST /api/document/collection/series/filter`](https://developer.bimetrics.de/reference/matches/filter-document-series.md) | Buchungsvorlagen suchen | read |
| [`POST /api/match/`](https://developer.bimetrics.de/reference/matches/create-match.md) | Belege und Umsätze zuordnen | matching:write |
| [`POST /api/match/correction-settlement/offset`](https://developer.bimetrics.de/reference/matches/offset-correction-credit.md) | Korrekturguthaben mit anderer Rechnung verrechnen | matching:write |
| [`POST /api/match/correction-settlement/refund`](https://developer.bimetrics.de/reference/matches/record-correction-refund.md) | Bereits erfolgte Rückzahlung erfassen | matching:write |
| [`POST /api/match/correction-settlement/reverse`](https://developer.bimetrics.de/reference/matches/reverse-correction-settlement.md) | Erfasste Rückzahlung oder Verrechnung zurücknehmen | matching:write |
| [`GET /api/match/correction-settlement/{correctionDocumentId}`](https://developer.bimetrics.de/reference/matches/get-correction-settlement.md) | Erstattungsfähiges Guthaben einer Rechnungskorrektur lesen | sales:read |
| [`GET /api/match/correction-settlement/{correctionDocumentId}/targets`](https://developer.bimetrics.de/reference/matches/list-correction-settlement-targets.md) | Geeignete Rechnungen für eine Verrechnung suchen | sales:read |
| [`POST /api/match/dismiss`](https://developer.bimetrics.de/reference/matches/dismiss-match-suggestion.md) | Zuordnungsvorschlag ausblenden | matching:write |
| [`DELETE /api/match/dismiss/{id}`](https://developer.bimetrics.de/reference/matches/restore-match-suggestion.md) | Ausgeblendeten Vorschlag zurückholen | matching:write |
| [`POST /api/match/payment`](https://developer.bimetrics.de/reference/matches/record-payment.md) | Bereits erfolgte Zahlung erfassen | matching:write |
| [`POST /api/match/payment/bulk`](https://developer.bimetrics.de/reference/matches/record-payments-in-bulk.md) | Zahlungen für mehrere Belege eintragen | matching:write |
| [`GET /api/match/payment/private`](https://developer.bimetrics.de/reference/matches/get-private-payment-state.md) | Privat bezahlt: Stand der Firma lesen | read |
| [`POST /api/match/payment/reverse`](https://developer.bimetrics.de/reference/matches/reverse-payment.md) | Erfasste Zahlung zurücknehmen | matching:write |
| [`POST /api/match/suggestions`](https://developer.bimetrics.de/reference/matches/list-match-suggestions.md) | Zuordnungsvorschläge lesen | read |
| [`POST /api/match/util/amountopen`](https://developer.bimetrics.de/reference/matches/calculate-open-amount.md) | Offenen Zuordnungsbetrag berechnen | read |
| [`GET /api/match/{id}`](https://developer.bimetrics.de/reference/matches/get-match.md) | Zuordnung lesen | read |
| [`DELETE /api/match/{id}`](https://developer.bimetrics.de/reference/matches/delete-match.md) | Zuordnung aufheben | matching:write |
| [`POST /api/match/{id}/cash-discount`](https://developer.bimetrics.de/reference/matches/settle-match-cash-discount.md) | Offenen Betrag einer Zuordnung als Skonto ausgleichen | matching:write |
| [`GET /api/match/{id}/cash-discount-preview`](https://developer.bimetrics.de/reference/matches/preview-match-cash-discount.md) | Skonto einer Zuordnung prüfen | read |
| [`GET /api/match/{id}/delete-preview`](https://developer.bimetrics.de/reference/matches/preview-delete-match.md) | Aufheben einer Zuordnung prüfen | read |
| [`POST /api/match/{id}/euro-amount`](https://developer.bimetrics.de/reference/matches/take-over-match-euro-amount.md) | Euro-Betrag aus der Zahlung übernehmen | matching:write |
| [`GET /api/match/{id}/euro-amount-preview`](https://developer.bimetrics.de/reference/matches/preview-match-euro-amount.md) | Euro-Betrag aus der Zahlung prüfen | read |
| [`POST /api/match/{id}/extend`](https://developer.bimetrics.de/reference/matches/extend-match.md) | Zuordnung erweitern | matching:write |
| [`POST /api/match/{id}/reminder-charges`](https://developer.bimetrics.de/reference/matches/settle-match-reminder-charges.md) | Mehrbetrag einer Zuordnung als Mahnkosten und Zinsen buchen | matching:write |
| [`GET /api/match/{id}/reminder-charges-preview`](https://developer.bimetrics.de/reference/matches/preview-match-reminder-charges.md) | Mahnkosten einer Zuordnung prüfen | read |
| [`GET /api/settings/matching`](https://developer.bimetrics.de/reference/matches/get-matching-settings.md) | Einstellung „Aus Zuordnungen lernen“ lesen | read |
| [`PUT /api/settings/matching`](https://developer.bimetrics.de/reference/matches/set-matching-settings.md) | „Aus Zuordnungen lernen“ ein- oder ausschalten | company:write |

## 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.
