bimetricsEntwickler
Belegpostfach

Adresse des Belegpostfachs lesen

Als Markdown ansehen

Benötigte Berechtigung:inbox:read(Postfach lesen)

Echte Wirkung

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

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

Liefert die Adresse, an die Rechnungen der Firma gehen. Lesen legt nichts an: Hat die Firma noch keine Adresse, antwortet die Route mit 404. Die Adresse entsteht, wenn jemand das Postfach in der App öffnet.

Benötigt einen Schlüssel mit der Berechtigung inbox:read.

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Antworten

Erfolg.

application/json
  1. response

Das Belegpostfach der Firma.

companyId?string

ID der Firma.

Formatuuid
createdAt?string

Anlage in bimetrics.

Formatdate-time
id?string

ID des Postfachs.

Formatuuid
inboundAddress?string

Adresse, an die Rechnungen der Firma gehen.

updatedAt?string

Letzte Änderung.

Formatdate-time
Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/email/inbox/" \  -H "Authorization: Bearer $BIMETRICS_API_KEY"
Beispielantwort
{  "companyId": "9c388e1f-04a6-4770-80bd-66cd98dd00d5",  "createdAt": "2026-09-01T09:00:00Z",  "id": "1a7d9e30-4c2b-4f86-b0d5-93e1a6c2f478",  "inboundAddress": "ab3xk9qr@inbox.example",  "updatedAt": "2026-09-01T09:00:00Z"}

Belege einer Buchungsvorlage lesen GET

Listet die Belege, die aus dieser Buchungsvorlage entstanden sind. Benötigt einen Schlüssel mit der Berechtigung `read`.

Mails suchen POST

Sucht Mails des Postfachs und liefert eine Seite der Treffer, **ohne** `bodyText` und `bodyHtml`: Den Text liefert `GET /api/email/inbox/item/{id}`. Unter „Offen“ stehen Mails mit `archived` = `null`, unter „Erledigt“ alle anderen. Benötigt einen Schlüssel mit der Berechtigung `inbox:read`.