Knoten „E-Rechnung validieren“ verwenden

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins agorum core electronic invoicing. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Interne ID: agorum.electronic.invoicing.validateInvoice

Mit diesem Knoten können Sie überprüfen, ob es sich bei einer E-Rechnung in PDF- oder XML-Format um eine valide E-Rechnung handelt. Wenn es sich um ein ZUGFErD-PDF handelt, wird die darin enthaltene XML-Struktur validiert.

Die Überprüfung erfolgt gegen den KoSIT-Validator, stellt also sicher, dass die XRechnung der angeforderten Norm entspricht. Die KoSIT ist die Koordierungsstelle für IT-Standards in der öffentlichen Verwaltung in Deutschland und beteiligt an der Entwicklung und Pflege des Standards XRechnung. Bei der Validierung handelt es sich also um eine technische Validierung, dass die Struktur der XML-Datei korrekt und vollständig gemäß den aktuellen Anforderungen ist.

Aussehen des Knotens

Verhaltensweise

Der Knoten überprüft eine E-Rechnung auf Basis der übergebenen Daten. Er validiert die XML-Struktur mit dem KoSIT-Validator und gibt das Ergebnis als Variable zurück.

Der Knoten erkennt für die Validierung, um welches XML-Format es sich handelt.

Wenn die Prüfung erfolgreich ist, ist das Ergebnis etwa:

 "validationResult": [],

Wenn die Prüfung nicht erfolgreich ist, ist das Ergebnis etwa:

  "validationResult": [
    {
      "level": "warning",
      "information": "Invalid content found for unknown element. Value is missing or other value is expected: .",
      "message": "[CII-SR-016] - CopyIndicator should not be present"
    },
 ]

Die Beschreibung eines Validierungsfehlers besteht aus:

level: Schweregrad des Fehlers (Warning, Error oder FatalError)
information: Kurzbeschreibung des Fehlers.
message: Beschreibung des Fehlers. Die Beschreibung enthält die Fehlerbeschreibung der Validierung.

Zusätzlich können Sie einen HTML-Prüfbericht mit den Validierungsergebnissen ausgeben lassen, für ein Beispiel siehe HTML-Prüfbericht.

Anwendung

Beispiel

Sie können diesen Knoten in Workflows integrieren, um zu prüfen, ob eine E-Rechnung eine formal korrekte XRechnung ist. Dazu können Sie etwa nach der erfolgreichen Prüfung, dass es sich bei einer Eingangsrechnung um eine E-Rechnung handelt, prüfen, dass sie formal korrekt bzw. valide ist, bevor sie sie weiterverarbeiten. Ein entsprechender Workflow könnte wie folgt aussehen:

Beispielworkflow mit dem validateInvoice-Knoten

Endpoints

Standard	Veränderbar?	Weitere Endpoints möglich?
Default (Inlet)	Nein, kann nur ausgeblendet werden.	nein, nicht nötig
true (Outlet)	Nein, kann nur ausgeblendet werden.	nein, nicht nötig
false (Outlet)	Nein, kann nur ausgeblendet werden.	nein, nicht nötig

Parameter

Parameter	Beschreibung	Beispiel
Eingangsvariable	Mit diesem Parameter geben Sie die Rechnungsdaten an, die validiert werden müssen. Der Parameter Eingangsvariable enthält ein Array von Elementen, die mit diesem Knoten verarbeitet werden sollen. Wird die Variable leer gelassen, werden automatisch die Attachments des Workflows genommen. Diese Attachments sind in der internen Variable sys_acw_attachments vorhanden. Für die generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.
Datenvariable	Die Daten beinhalten das Resultat der Prüfung, ob es sich um valides XML gemäß dem KoSIT-Validator handelt. Sollte es sich bei dem Objekt nicht um eine valide XML-Struktur handeln, werden die Validierungsfehler als Inhalt zurückgegeben. Für die generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.	validationResult Für ein Beispiel einer fehlschlagenden Validierung siehe Verhaltensweise.
Ausgangsvariable	Sie können sich als Ergebnis der Überprüfung das Validierungsprotokoll als HTML-Report ausgeben lassen. Geben Sie dazu einen Wert für den Parameter Ausgangsvariable an. Ohne Angabe eines Werts wird kein Report erzeugt.	htmlReport
Rechte	Siehe Rechte auf Knoten vergeben

Tipp: Verwenden Sie die Variablenauswahl, um einen Überblick über alle nutzbaren Variablen zu erhalten.

Beispiel für einen HTML-Prüfbericht

Wenn Sie einen HTML-Report erzeugen lassen, wird ein Dokument wie in folgendem Beispiel erzeugt.

Die Validierungsergebnisse beinhalten neben Fehlern auch Warnungen, wie auch hier zu sehen. Sie können bei Warnungen für jeden Hinweis prüfen, ob eine Änderung der XRechnung erforderlich ist. Es handelt sich dabei nicht um Fehler, die zwingend korrigiert werden müssen.

Beginn eines HTML-Reports mit den Validierungsergebnissen