Ga naar inhoud

Werken met de E-POSTBUSINESS API

De E-POSTBUSINESS API van de Deutsche Post maakt een naadloze automatisering van de briefverzending mogelijk via het Documentenverzend-platform. Door deze API te integreren, wordt het gehele proces – van de digitale documentcreatie tot de fysieke briefbezorging – volledig geautomatiseerd, zodat geen handmatige inspanning vereist is.

De API neemt de volgende stappen voor zijn rekening:

  • Afdrukken – Zet digitale documenten om in fysieke brieven
  • Inpakken – Steekt documenten automatisch in enveloppen
  • Frankeren – Bereidt brieven voor verzending per post

Zodra de brief klaar is, zorgt de Deutsche Post voor de bezorging, waardoor handmatige ingrepen overbodig zijn. Deze automatisering bespaart bedrijven tijd en kosten en zorgt tegelijkertijd voor een betrouwbare en efficiënte verzendoplossing.

Info

Voordat u succesvol brieven kunt verzenden, moet de E-POSTBUSINESS API worden ingesteld. Gedetailleerde instructies voor de installatie vindt u hier.

Een document maken en verzenden via E-POST

Met de E-POSTBUSINESS API kunnen gebruikers documenten rechtstreeks vanuit Business Central als brieven verzenden.

Stappen om een brief te maken en te verzenden via de API:

  1. Navigeer naar een document (bijv. geboekte verkoopfactuur) in Business Central.
  2. Gebruik de actie E-Post verzenden in de Document Dispatch-factbox.
    • Zorg ervoor dat u een verzendprofiel heeft voor de tabel waarvan een document moet worden verzonden.

  3. Voeg de gewenste documenten of bijlagen toe en kies uw specifieke gewenste verzendopties. Deze opties omvatten:

    • Aangetekend
      • Aangetekend met afgifte (Drop-Off Registered Mail):
        • De brief wordt rechtstreeks in de brievenbus van de ontvanger bezorgd, zonder dat een handtekening vereist is.
        • Deze optie biedt basisvolging en een afleverbewijs dat bevestigt dat de brief in de brievenbus is achtergelaten.
        • Ideaal voor belangrijke, maar niet kritische documenten waarbij geen handtekening vereist is, zoals kennisgevingen of algemene correspondentie.
      • Aangetekend (Registered Mail):
        • De brief wordt persoonlijk aan de ontvanger of een gemachtigde persoon overhandigd tegen handtekening.
        • De afzender ontvangt een bevestiging dat de brief is bezorgd, maar geen extra bewijs wie deze precies heeft ontvangen.
        • Geschikt voor gevoelige documenten waarbij een directe overdracht vereist is, zoals contracten of juridische mededelingen.
      • Aangetekend met ontvangstbewijs (Registered Mail with Return Receipt):
        • Naast de handtekening van de ontvanger ontvangt de afzender een schriftelijke afleverbevestiging (ontvangstbewijs).
        • Het ontvangstbewijs bevat de naam en handtekening van de ontvanger en dient als juridisch geldig ontvangstbewijs.
        • Aanbevolen voor zeer belangrijke of juridisch bindende documenten, zoals ontslagbrieven, juridische mededelingen of officiële communicatie.
      • Voorblad
        • Voegt een voorblad toe aan de verzending, dat extra informatie kan bevatten of als scheidingsblad tussen verschillende documentsecties kan dienen.
      • Dubbelzijdig
        • Maakt dubbelzijdig (duplex) afdrukken mogelijk om papier te besparen en de verzending milieuvriendelijker te maken.
      • Kleur
        • Geeft aan of het document in kleur of zwart-wit moet worden afgedrukt. Dit is nuttig voor documenten die afbeeldingen of belangrijke kleurgecodeerde informatie bevatten.

  4. Kies de actie OK.

  5. Na bevestiging in de dialoog verzendt de API het document automatisch naar de Deutsche Post, waar het wordt afgedrukt en verzonden.

Info

De combinatie van duplex en aangetekend is niet mogelijk. Als u duplex selecteert, wordt de optie aangetekend uitgeschakeld. Deze functie vereist een actieve API-verbinding met de Deutsche Post.

Een document verzenden via E-POST naar het buitenland

De E-POSTBUSINESS API ondersteunt ook internationale documentverzending. Om een document naar het buitenland te verzenden, moeten eerst de vereiste configuraties worden voltooid.

Stappen voor internationale verzending:

  1. Navigeer naar uw ontvanger, bijvoorbeeld een klant die voor deze instelling is bedoeld.
  2. Selecteer de ontvanger en open de kaart van de ontvanger.
  3. Stel de land-/regiocode van de ontvanger in om een correcte adressering voor de verzending te waarborgen.
  4. Navigeer in het dropdown-menu van het veld land-/regiocode naar de volledige landen-/regiolijst.
    • Als de land-/regio naam in het Nederlands in de volledige landen-/regiolijst aanwezig is, maar de geselecteerde omgevingstaal van Business Central niet Nederlands is, ga dan verder met de volgende stap.
    • Anders, als zowel de naam als de omgeving in het Nederlands zijn, controleer dan eenvoudig de landennaam en pas deze indien nodig aan als deze niet overeenkomt met ISO 3166‑1.
  5. Als de omgevingstaal niet Nederlands is, moeten de Nederlandse vertalingen voor de landen-/regio namen handmatig worden ingevoerd volgens de vereisten van de Deutsche Post.
    • Deze kunnen worden toegevoegd via de actie Vertalingen op dezelfde pagina.
    • De landennaamvertalingen voor de taalcodes NLD moeten voldoen aan de ISO 3166‑1-normen en in het veld Naam worden ingevoerd om een correcte verzending te waarborgen.
  6. Zodra de vertaling is voltooid en het internationale adres is geconfigureerd, kunt u het document zoals gebruikelijk verzenden via de actie E-Post verzenden in de Documenten-Central-factbox.

Info

Om een zelfcontrole van de instelling uit te voeren, kunt u de actie E-Post verzenden Dialoog in de Documenten-Central-factbox gebruiken. Als de configuratie correct is, opent de dialoog en toont de landennaam in hoofdletters in het veld Land. Anders, als er een foutconfiguratie is met betrekking tot de internationale verzendconfiguratie, wordt de dialoog niet geopend en wordt er een fout weergegeven.

Als de verzending zonder opgave van een land-/regiocode wordt uitgevoerd (d.w.z. letterlijk leeg gelaten), beschouwt de Deutsche Post dit als binnenlandse verzending. Daarom is het noodzakelijk om de configuratie van de land-/regiocode voor de verzending naar het buitenland te voltooien.

Weergave van de verzendstatus in Business Central

Alle zendingen, inclusief E-Post-verzending, worden vermeld en geregistreerd in de Document Dispatch - wachtrij. Binnen deze wachtrij is er een specifieke actie voor E-Post-invoeren genaamd "E-Post-informatie".

Door deze actie te selecteren, wordt een pagina geopend die de volgende informatie weergeeft:

Algemene informatie

  • Invoernummer
  • Bron-document
  • Testmodus-indicator
  • Datum van de laatste statusupdate

Briefinformatie

  • Brief-ID
  • Geselecteerde verzendopties

Ontvangerinformatie

  • Ontvanger naam
  • Ontvanger adres

Statusvolging

Een ListPart registreert alle opgevraagde statussen, elk met een status-ID en een statuscode.

Status-ID's en uitleg:

1 - Ontvangst van de zending - De zending is succesvol verzonden en er zijn geen schema- of inhoudsoverschrijdingen in de JSON vastgesteld. - Statustoewijzing: Na succesvolle upload van de zending.

2 - Verwerking van de zending - Het PDF-bestand is gecontroleerd op E-Post-conformiteit en goedgekeurd voor afdrukken. - Opmerking: Ondanks grondige controle kunnen technische fouten in het PDF-bestand leiden tot verwerkingsfouten in het drukcentrum, wat resulteert in Status 99. - Statustoewijzing: Enkele minuten na ontvangst van de zending.

3 - Overdracht aan het drukcentrum - De zending is overgedragen aan het drukcentrum voor productie. - Opmerking: Als technische fouten een verwerkingsstoring veroorzaken, wordt Status 99 in plaats van Status 4 weergegeven. - Statustoewijzing: Binnen enkele uren na verwerking.

4 - Verwerking in het drukcentrum - De zending is door het drukcentrum gemarkeerd als "verzonden". - Statustoewijzing: 1-2 werkdagen na overdracht aan het drukcentrum.

99 - Verwerkingsfout - Zie foutlijst voor details.

Wachtrij-invoer Status

De status van een wachtrij-invoer wordt bijgewerkt volgens de processtappen. Zodra de status "4" (Verwerking in het drukcentrum) is bereikt, wordt de invoer gemarkeerd als "verzonden".

Na een succesvolle E-Post-verzending krijgt de wachtrij-invoer de status "Verzending gestart". Deze status geeft het begin van het verzendproces aan. Hij wordt automatisch bijgewerkt met alle volgende E-Post-processtatussen, op voorwaarde dat de jobwachtrij "Document Dispatch Automatische E-Post-Briefstatusupdate" draait.

Statuscodes en uitleg:

Fouten: Vereisen actie, verwerking afgebroken

  • E001 - Ongeldige inloggegevens – Controleer de inloggegevens
  • E002 - Ongeldige inloggegevens – VendorSubID onjuist
  • E003 - Te veel SMS-aanvragen – 15 minuten geblokkeerd
  • E004 - EKP geblokkeerd door de Deutsche Post
  • E101 - Ongeldig token – Verlopen
  • E201 - Ongeldige statusopvraag – Geen zending gevonden
  • E203 - Afwijking van de adresmetadata vastgesteld
  • E301 - Geen PDF-formaat herkend
  • E302 - Overtreding van het DVF-beperkingsgebied
  • E303 - Maximale bestandsgrootte van 20 MB overschreden
  • E304 - Maximale pagina-aantal van 94 overschreden
  • E305 - Ongeldige land-/regiocode
  • E306 - Ongeldig ontvangeradresformaat
  • E307 - Eerste pagina in liggend formaat
  • E308 - Niet-DIN A4-formaat herkend
  • E309 - Dubbele bestandsnamen herkend
  • E311 - Ongeldige combinatie: Aangetekend en internationale verzending
  • E312 - Ongeldige combinatie: Duplex + Aangetekend
  • E313 - Briefschema-overtreding
  • E314 - Bestandsgrootte van het voorblad overschrijdt 1 MB
  • E315 - Verwerkingsfout bij de zending
  • E316 - Upload-fout
  • E317 - Ongeldig aangetekend-formaat
  • E318 - Afwijzing in het drukcentrum
  • E319 - EKP niet goedgekeurd voor het drukcentrum – Live-verzending niet mogelijk
  • E320 - Maximale aantal testzendingen per dag bereikt
  • E322 - Frequentie van statusopvragen te hoog – Minimaal 5 seconden tussen aanvragen
  • E323 - Geen inhoud in het ontvangergebied herkend (lege pagina)
  • E333 - Afzenderadres niet op het document aanwezig.
  • E399 - Algemene fout
  • E501 - API-status: Inactief
  • E601 - Plugin-fout
  • E900 - Onbepaalde fout

Waarschuwingen: Kunnen actie vereisen, maar de verwerking gaat door

  • W101 - PDF/A-conversiewaarschuwingen
  • W201 - Adresgebied overschreden
  • W202 - Linker beperkingsgebied overschreden (wordt wit gemaakt)
  • W203 - Afwijkingen van de adresmetadata
  • W220 - Vanaf 01-10-2022 worden de ontvangstbewijsadresdetails automatisch uit het zichtbare afzendergebied van de brief geëxtraheerd
  • W301 - Afzenderadres ontbreekt (vanaf 01-07-2025 wordt het ontbreken van een afzenderadres op ingediende documenten als fout beschouwd (“E333”)).
  • W501 - API-status: Onderhoudsbericht
  • W601 - Plugin-waarschuwing

Informatieberichten: Geen actie vereist

  • I101 - Extra optie: PDF naar PDF/A-conversie
  • I501 - API-status: OK
  • I601 - Plugin-info
  • I701 - Statusupdate voor zendingvolging
  • I751 - Statusmelding voor de doelregio

E-Post API Gezondheidscheck

Document Dispatch biedt een geïntegreerde manier om de status van uw E‑POSTBUSINESS API-verbinding te controleren.

Volg deze stappen om de E-POST Business API-status te controleren:

  1. We beginnen in de rol Document Dispatch - Administrator.
  2. Open Module-instelling uit het menu Instelling in de menubalk.
  3. Klik op E-Post in het menu Document Dispatch Module-instelling.
  4. Voer de actie E-Post API Gezondheidscheck uit.

U ontvangt informatie rechtstreeks van de Deutsche Post E‑POSTBUSINESS API.

Wachtrijlogboek voor E-Post-invoeren

Het Documentenverzend-wachtrijlogboek volgt gebeurtenissen met betrekking tot elk verzendtype. Voor E-Post-invoeren biedt het logboek een gedetailleerde geschiedenis van de verzendacties, inclusief:

  • Wanneer een E-Post-brief succesvol is verzonden.
  • Of een brief in testmodus is verzonden.
  • Systeemfouten of storingen tijdens het verzendproces.

Gebruikers kunnen de wachtrijlogboeken binnen de Documentenverzend-wachtrij controleren met de actie Logboek weergeven om verzendactiviteiten te monitoren en mogelijke problemen te diagnosticeren.

E-Post Logboek

Het E-Post Logboek biedt een gedetailleerde controle van de systeemacties met betrekking tot E-Post, inclusief:

  • Inlogpogingen: Succesvolle en mislukte authenticatiepogingen.
  • Wachtwoordwijzigingen: Registreert wanneer een wachtwoord voor de E-POSTBUSINESS API-gebruiker is gewijzigd.
  • SMS-code-aanvraagpogingen: Wanneer een nieuwe SMS-code succesvol is aangevraagd en wanneer dit is mislukt.

Het E-Post-logboek stelt beheerders in staat om wijzigingen te volgen en de veiligheid van de E-POSTBUSINESS API te waarborgen.

Werken met de automatische adressetter

De automatische adressetter zorgt ervoor dat ontvangeradressen correct zijn gepositioneerd voor de E-Post-briefverzending.

Stappen voor het gebruik van de automatische adressetter:

  1. Open bijvoorbeeld een geboekte verkoopfactuur in Business Central.
  2. Selecteer een invoer en klik op de actie E-Post verzenden in de Documentenverzend-factbox.
  3. Zorg ervoor dat een adresoverlaysconfiguratie is ingesteld en geactiveerd.
  4. Bij het maken van een document voor de E-Post-verzending past het systeem automatisch de vooraf ingestelde adresoverlay toe.
  5. Controleer de documentvoorvertoning in de dialoog om ervoor te zorgen dat de adresoverlay correct is toegepast.
  6. Verzend het document door de dialoog te bevestigen met de actie OK.

Door gebruik te maken van de automatische adressetter kunnen gebruikers voldoen aan de vereisten van de Deutsche Post, fouten verminderen en de verzending optimaliseren.

Zie ook