bimetricsEntwickler
Belegpostfach

Mail zurückholen

Als Markdown ansehen

Benötigte Berechtigung:inbox:write(Postfach bearbeiten)

Echte Wirkung

Ändert Daten der Firma; wird atomar mit Idempotenzbeleg und Herkunft protokolliert.
post/api/email/inbox/item/{id}/unarchive

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

Holt eine Mail von „Erledigt“ nach „Offen“, wie „Zurückholen“ in der App. Erst dann lassen sich weitere Anhänge übernehmen.

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

Authentifizierung

headerAuthentifizierungBearer <bm_…>

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

Pfadparameter

id*string

ID der Mail (UUID).

Formatuuid

Header-Parameter

Idempotency-Key*string

Stabiler Schlüssel für genau diese Änderung: 1–128 druckbare ASCII-Zeichen ohne Leerzeichen. Bei Wiederholungen denselben Schlüssel und unveränderten Inhalt senden; das Ergebnis wird nicht nochmals erzeugt.

Muster^[!-~]+$
Länge1 <= length <= 128

Antworten

Erfolg.

application/json
  1. response

Die Mail nach dem Ablegen oder Zurückholen.

archived?|

Seit wann die Mail unter „Erledigt“ steht; null unter „Offen“.

Formatdate-time
mailId?string

ID der Mail.

Formatuuid
notImported?array<>|

Lesbare Anhänge, die nicht übernommen sind.

replayed?boolean

True bei sicherer Wiederholung eines bereits erfolgreichen Aufrufs.

Beispielanfrage
curl --fail-with-body "https://app.bimetrics.de/api/email/inbox/item/497f6eca-6276-4993-bfeb-53cbbbba6f08/unarchive" -X POST \  -H "Authorization: Bearer $BIMETRICS_API_KEY" \  -H "Idempotency-Key: rechnung-2026-001"
Beispielantwort
{  "archived": null,  "mailId": "6c1f0a52-3d8e-4b7a-9f21-7e4b2d90c6a3",  "notImported": [    {      "filename": "RE-2026-0042.pdf",      "id": "b84e27d1-5a90-4c63-8e1f-2c7a9d03f514"    }  ],  "replayed": false}

Seite eines Anhangs ansehen GET

Liefert eine Seite eines Anhangs als Bild (Base64), wie die Vorschau im Postfach, nur für Anhänge mit `valid` = `true`, sonst `409 InboxAttachmentNotImportable`. `pageCount` nennt die Seiten; eine Seite dahinter kommt ohne `pages`. Der erste Aufruf rendert die Datei und kann einige Sekunden dauern. Benötigt einen Schlüssel mit der Berechtigung `inbox:read`.

Konten ohne Bankverbindung lesen GET

Listet die aktiven Bankkonten ohne Bankverbindung mit dem Zeitraum ihrer Umsätze und dem letzten Import. Benötigt einen Schlüssel mit der Berechtigung `read`.