Zum Inhalt

Automatisierter Briefversand mit der E-POSTBUSINESS API

Die E-POSTBUSINESS API der Deutschen Post ermöglicht eine nahtlose Automatisierung des Briefversands über die Dokumentenversand-Plattform. Durch die Integration dieser API wird der gesamte Prozess – von der digitalen Dokumentenerstellung bis zur physischen Briefzustellung – vollständig automatisiert, sodass kein manueller Aufwand erforderlich ist.

Die API übernimmt folgende Schritte:

  • Drucken – Wandelt digitale Dokumente in physische Briefe um
  • Kuvertierung – Steckt Dokumente automatisch in Umschläge
  • Frankierung – Bereitet Briefe für den Postversand vor

Sobald der Brief bereit ist, übernimmt die Deutsche Post die Zustellung, wodurch manuelle Eingriffe entfallen. Diese Automatisierung spart Unternehmen Zeit und Kosten und stellt gleichzeitig eine zuverlässige und effiziente Lösung für den Postversand dar.

Info

Bevor Briefe erfolgreich versendet werden können, muss die E-POSTBUSINESS API eingerichtet werden. Detaillierte Anweisungen zur Einrichtung finden Sie hier.

Erstellen und Versenden eines Dokuments per E-POST

Mit der E-POSTBUSINESS API können Benutzer Dokumente direkt aus Business Central als Briefe versenden.

Schritte zum Erstellen und Versenden eines Briefes über die API:

  1. Navigieren Sie zu einem Dokument (z. B. gebuchte Verkaufsrechnung) in Business Central.
  2. Wählen Sie die Aktion E-Post senden im Dokumentenversand-Factbox.
  3. Stellen Sie sicher, dass ein Versandprofil für die Tabelle vorhanden ist, aus der das Dokument versendet werden soll.

  4. Fügen Sie die gewünschten Dokumente oder Anhänge hinzu und wählen Sie die gewünschte Versandoption. Zu den Einstellungen gehören:

    • Einschreiben
      • Einwurf Einschreiben:
        • Der Brief wird direkt in den Briefkasten des Empfängers zugestellt, ohne dass eine Unterschrift erforderlich ist.
        • Diese Option bietet eine grundlegende Sendungsverfolgung und Zustellnachweis.
        • Ideal für wichtige, aber nicht kritische Dokumente wie Mitteilungen oder allgemeine Korrespondenz.
      • Einschreiben:
        • Der Brief wird persönlich an den Empfänger oder eine bevollmächtigte Person gegen Unterschrift übergeben.
        • Der Absender erhält eine Bestätigung über die Zustellung, jedoch ohne Nachweis, wer genau den Brief erhalten hat.
        • Geeignet für sensible Dokumente wie Verträge oder rechtliche Mitteilungen.
      • Einschreiben Rückschein:
        • Neben der Unterschrift des Empfängers erhält der Absender eine schriftliche Zustellbestätigung (Rückschein).
        • Der Rückschein enthält den Namen und die Unterschrift des Empfängers und dient als rechtskräftiger Zustellnachweis.
        • Empfehlenswert für hochwichtige oder rechtsverbindliche Dokumente wie Kündigungen, behördliche Schreiben oder offizielle Mitteilungen.
    • Titelseite
      • Fügt eine Titelseite hinzu, die dann die Adresse der zuzustellenden Person beinhaltet.
    • Duplexdruck
      • Ermöglicht den doppelseitigen Druck zur Papiereinsparung und umweltfreundlicheren Versand.
    • Farbe
      • Legt fest, ob der Brief farbig oder schwarz-weiß gedruckt wird. Nützlich für Briefe mit Bildern oder farbcodierten Informationen.

  5. Wählen Sie die Aktion OK.

  6. Durch die Bestätigung im Dialog, sendet die API das Dokument automatisch an die Deutsche Post, wo es gedruckt und versendet wird.

Info

  • Die Kombination aus Duplexdruck und Einschreiben ist nicht möglich.
  • Diese Funktion erfordert eine aktive API-Verbindung zur Deutschen Post.

Versenden eines Dokuments per E-POST ins Ausland

Die E-POSTBUSINESS API unterstützt auch den internationalen Versand von Dokumenten. Um ein Dokument ins Ausland zu senden, müssen zuvor die entsprechenden Einrichtungen vorgenommen werden.

Schritte zum internationalen Versand:

  1. Navigieren Sie zu ihrem Empfänger beispielsweise einem Debitor, der für die Einrichtung bestimmt ist.
  2. Wählen Sie den Empfänger aus und öffnen Sie die Empfängerkarte.
  3. Stellen Sie zuvor den Länder/Regionscode des Empfängers ein, um sicherzustellen, dass der Versand korrekt adressiert wird.
  4. Navigieren Sie über das Dropdown-Menü des Feldes Länder/Regionscode in die vollständige Länder-/Regionliste.
    • Falls der Länder-/Regionsname zwar beispielsweise auf Deutsch in der vollständigen Länder-/Regionliste enthalten ist ,aber die gewählte Umgebungssprache von Business Central nicht Deutsch ist, müssen Sie dem nächsten Schritt folgen.
    • Andernfalls, wenn der Name und die Umgebung in deutscher Sprache vorliegen, überprüfen Sie lediglich den Ländernamen und dessen Übereinstimmung mit der ISO 3166‑1 und passen ihn gegebenenfalls an.
  5. Falls die Umgebungssprache nicht zutrifft, müssen aufgrund der Vorgaben der Deutschen Post, immer die deutschen Übersetzungen für die Länder/Regionsnamen manuell durchgeführt werden.
    • Diese können über die Aktion Übersetzugnen auf der selben Seite vorgenommen werden.
    • Die Übersetzungen der Ländernamen für den Sprachcode DEU müssen den Vorgaben der ISO 3166-1 entsprechen und im Feld Name eingetragen werden, um eine korrekte Zustellung zu gewährleisten.
  6. Nachdem die Übersetzung abgeschlossen ist und die Auslandsadresse eingerichtet wurde, können Sie den Versand wie gewohnt über die Aktion E-Post senden in der Document Central-Factbox ausführen.

Info

Um eine Selbstüberprüfung der richtigen Einrichtung durchzuführen, können Sie die Aktion E-Post Dialog senden in der Document Central-Factbox ausführen. Wenn die Einrichtung korrekt ist, wird der Dialog geöffnet und im Feld Land der Name des Landes in Großbuchstaben angezeigt, andernfalls öffnet sich der Dialog, bei einer fehlerhaften Ländereinrichtung im Bezug auf den Auslandsversand, nicht und wirft einen Fehler.

Wird der Versand ohne eine konkrete Angabe des Ländercodes durchgeführt, also buchstäblich leer gelassen, bedeutet dies für die Deutsche Post, dass der Versand als Inlandsversand behandelt wird. Daher ist es notwendig, die Einrichtung des Ländercodes vor dem Versand ins Ausland abzuschließen.

--

Anzeige des Versandstatus in Business Central

Alle Sendungen, einschließlich E-Post-Versand, werden in der Document Dispatch - Warteschlange aufgeführt und protokolliert. Innerhalb dieser Warteschlange gibt es eine spezifische Aktion für E-Post-Einträge namens "E-Post-Informationen".

Durch Auswahl dieser Aktion wird eine Seite geöffnet, die folgende Informationen anzeigt:

Allgemeine Informationen

  • Eintragsnummer
  • Quell-Dokument
  • Testmodus-Indikator
  • Datum der letzten Statusaktualisierung

Briefinformationen

  • Brief-ID
  • Ausgewählte Versandoptionen

Empfängerinformationen

  • Empfängername
  • Empfängeradresse

Statusverfolgung

Eine ListPart protokolliert alle abgefragten Status, jeweils mit einer Status-ID und einem Status-Code.

Status-IDs und Erklärungen:

1 - Annahme der Sendung - Die Sendung wurde erfolgreich übermittelt, und es wurden keine Schema- oder Inhaltsverstöße im JSON festgestellt. - Statuszuweisung: Nach erfolgreichem Hochladen der Sendung.

2 - Bearbeitung der Sendung - Das PDF wurde auf E-Post-Konformität überprüft und für den Druck freigegeben. - Hinweis: Trotz gründlicher Überprüfung können technische Fehler im PDF zu Verarbeitungsfehlern im Druckzentrum führen, was zu Status 99 führt. - Statuszuweisung: Wenige Minuten nach der Annahme der Sendung.

3 - Übergabe an das Druckzentrum - Die Sendung wurde an das Druckzentrum zur Produktion übergeben. - Hinweis: Falls technische Fehler eine Verarbeitungsstörung verursachen, wird Status 99 anstelle von Status 4 ausgegeben. - Statuszuweisung: Innerhalb weniger Stunden nach der Bearbeitung.

4 - Verarbeitung im Druckzentrum - Die Sendung wurde vom Druckzentrum als "versendet" markiert. - Statuszuweisung: 1-2 Werktage nach der Übergabe an das Druckzentrum.

99 - Verarbeitungsfehler - Siehe Fehlerliste für Details.

Statuscodes und Erklärungen:

Fehler: Erfordern Maßnahmen, Verarbeitung abgebrochen

  • E001 - Ungültige Anmeldedaten – Überprüfen Sie die Zugangsdaten
  • E002 - Ungültige Anmeldedaten – VendorSubID falsch
  • E003 - Zu viele SMS-Anfragen – Gesperrt für 15 Minuten
  • E004 - EKP von der Deutschen Post gesperrt
  • E101 - Ungültiges Token – Abgelaufen
  • E201 - Ungültige Statusabfrage – Keine Sendung gefunden
  • E203 - Abweichung in den Adress-Metadaten festgestellt
  • E301 - Kein PDF-Format erkannt
  • E302 - Verstoß gegen DVF-Einschränkungen
  • E303 - Maximale Dateigröße von 20 MB überschritten
  • E304 - Maximale Seitenanzahl von 94 überschritten
  • E305 - Ungültiger Ländercode
  • E306 - Ungültiges Empfängeradressformat
  • E307 - Erste Seite im Querformat
  • E308 - Nicht-DIN-A4-Format erkannt
  • E309 - Doppelter Dateiname erkannt
  • E311 - Ungültige Kombination: Einschreiben und internationaler Versand
  • E312 - Ungültige Kombination: Duplex + Einschreiben
  • E313 - Verstoß gegen das Briefschema
  • E314 - Titelseitengröße überschreitet 1 MB
  • E315 - Verarbeitungsfehler in der Sendung
  • E316 - Upload-Fehler
  • E317 - Ungültiges Einschreiben-Format
  • E318 - Ablehnung im Druckzentrum
  • E319 - EKP nicht für das Druckzentrum freigegeben – Live-Versand nicht möglich
  • E320 - Maximale Anzahl an Testsendungen pro Tag erreicht
  • E322 - Zu hohe Frequenz der Statusabfragen – Mindestens 5 Sekunden zwischen Abfragen
  • E323 - Kein Inhalt im Empfängerbereich erkannt (leere Seite)
  • E333 - Senderadresse auf Dokument nicht vorhanden.
  • E399 - Allgemeiner Fehler
  • E501 - API-Status: Inaktiv
  • E601 - Plugin-Fehler
  • E900 - Unbestimmter Fehler

Warnungen: Können Maßnahmen erfordern, Verarbeitung läuft weiter

  • W101 - Warnungen zur PDF/A-Konvertierung
  • W201 - Adressbereich überschritten
  • W202 - Linker eingeschränkter Bereich überschritten (wird ausgeblendet)
  • W203 - Abweichungen in den Adress-Metadaten
  • W220 - Ab dem 01.10.2022 werden Rückschein-Adressdaten automatisch aus dem sichtbaren Absenderbereich des Briefes extrahiert
  • W301 - Absenderadresse fehlt (ab dem 01.07.2025 wird das Fehlen einer AGB-konformen Absenderangabe auf eingelieferten Dokumenten als Fehler („E333“) gewertet.)
  • W501 - API-Status: Wartungshinweis
  • W601 - Plugin-Warnung

Informationsmeldungen: Keine Maßnahmen erforderlich

  • I101 - Zusätzliche Option: PDF-zu-PDF/A-Konvertierung
  • I501 - API-Status: OK
  • I601 - Plugin-Info
  • I701 - Statusupdate für Sendungsverfolgung
  • I751 - Statusmeldung für Zielregion

Warteschlangenprotokoll für E-Post-Einträge

Das Dokumentenversand-Warteschlangenprotokoll verfolgt Ereignisse im Zusammenhang mit jedem Versandtyp. Für E-Post-Einträge bietet das Protokoll eine detaillierte Historie der Versandaktionen, einschließlich:

  • Wann ein E-Post-Brief erfolgreich gesendet wurde.
  • Ob ein Brief im Testmodus gesendet wurde.
  • Systemfehler oder Ausfälle während des Versandprozesses.

Benutzer können die Warteschlangenprotokolle innerhalb der Dokumentenversand-Warteschlange mit der Aktion Protokoll anzeigen überprüfen, um Versandaktivitäten zu überwachen und mögliche Probleme zu diagnostizieren.

E-Post-Protokoll

Das E-Post-Protokoll bietet eine detaillierte Überprüfung der Systemaktionen im Zusammenhang mit E-Post, einschließlich:

  • Anmeldeversuche: Erfolgreiche und fehlgeschlagene Authentifizierungsversuche.
  • Passwortänderungen: Dokumentiert, wann ein Passwort für den E-POSTBUSINESS-API-Benutzer geändert wurde.
  • SMS-Code-Anfragen: Erfolgreiche und fehlgeschlagene Anfragen für Authentifizierungs-SMS-Codes.

Das E-Post-Protokoll ermöglicht Administratoren, Änderungen zu verfolgen und die Sicherheit der E-POSTBUSINESS API zu gewährleisten.

Arbeiten mit dem automatischen Adress-Setzer

Der automatische Adress-Setzer stellt sicher, dass Empfängeradressen korrekt für den E-Post-Briefversand positioniert sind.

Schritte zur Verwendung des automatischen Adress-Setzers:

  1. Öffnen Sie beispielsweise eine gebuchte Verkaufsrechnung in Business Central.
  2. Wählen Sie einen Eintrag und klicken Sie auf die Aktion E-Post senden im Dokumentenversand-Factbox.
  3. Stellen Sie sicher, dass eine Adressüberlagerungskonfiguration eingerichtet und aktiviert wurde.
  4. Beim Erstellen eines Dokuments für den E-Post-Versand wendet das System automatisch die voreingestellte Adressüberlagerung an.
  5. Überprüfen Sie die Dokumentenvorschau im Dialog, um sicherzustellen, dass die Adressüberlagerung korrekt angewendet wurde.
  6. Senden Sie das Dokument durch Bestätigung des Dialogs mit der OK-Aktion.

Durch die Nutzung des automatischen Adress-Setzers können Benutzer die Anforderungen der Deutschen Post einhalten, Fehler reduzieren und den Versand optimieren.

Siehe auch