ZUGFeRD PDF/A

ZUGFeRD steht als Kurzform für "Zentraler User Guide des Forums elektronische Rechnung Deutschland“. ZUGFeRD ist ein Dateiformat für die Standardisierung elektronischer Rechnungen und wird beim elektronischen Rechnungsaustausch eingesetzt. Es vereint die Vorteile der Formate XML und PDF in einer einzigen Datei, indem zum bildhaften Beleg im PDF/ A-3-Standard zusätzlich alle Rechnungsinformationen in elektronisch verarbeitbarer Form integriert werden. So können sie sowohl maschinell verarbeitet als auch visuell gelesen werden. ZUGFeRD-kompatible Rechnungen bestehen aus einem PDF-Dokument im PDF/A-3-Format, das den Datensatz einer Rechnung als eingebettete strukturierte Daten in XML-Form enthält.

Die Nutzung des ZUGFeRD Utility ist lizenzpflichtig.

Verwendung

Mit dem ZUGFeRD PDF/A-3 Utility können Sie sowohl eingehende ZUGFeRD-Dateien auslesen als auch Rechnungsdaten aus dem Workflow in das ZUGFeRD-Format konvertieren.

Die beiden Standards ZUGFeRD 1.0 und ZUGFeRD 2 (2.0, 2.1 und 2.2) werden unterstützt. Im Modus Auslesen wird die ZUGFeRD-Version automatisch erkannt. Im Modus Erstellen müssen Sie den Standard, für den die PDF-Datei erstellt werden soll, aus der Auswahlliste ZUGFeRD-Version im Dialog Einstellungen wählen.

Funktionsprinzip

Auslesen: ZUGFeRD PDF/A-3 > XML

Das ZUGFeRD Utility kann PDF/A-3 ZUGFeRD-Dateien lesen und XML-Rechnungsdaten extrahieren. Die extrahierten Rechnungsdaten werden als `ZUGFeRD-invoice.xml `und zusätzliche Metadaten als Workflow-Variable in die Ausgangsnachricht geschrieben und zur Weiterverarbeitung im Workflow bereitgestellt.
Erstellen: XML + PDF/A-1 > ZUGFeRD PDF/A-3

Um im Workflow Dokumente in das ZUGFeRD PDF/A-3-Archiv-Format zu konvertieren, werden über die Eingangsnachricht ein PDF/A-1-Dokument und zwei Variablen mit den Rechnungsinformationen in Form einer ZUGFeRD-invoice.xml und den zugehörigen Metadaten zu einer ZUGFeRD-Datei im PDF/A-3-Format zusammengeführt.

Moduleigenschaften und -variablen des ZUGFeRD Utility

Folgende Moduleigenschaften können beim ZUGFeRD Utility gesetzt werden:

Name Erklärung/Wert Default

Name	Erklärung/Wert	Default
`pluginType`	Zum Auslesen und Erstellen verwendbar. Legt fest, ob ZUGFeRD gelesen oder geschrieben wird: 0 - Lesen 1 - Schreiben	`0`
`validateInvoice`	Zum Auslesen und Erstellen verwendbar. `true` - Die `ZUGFeRD-invoice.xml` wird nach dem Schema `ZUGFeRD_1p0.xsd` validiert. `false` - Es erfolgt keine Validierung der `ZUGFeRD-invoice.xml`.	`false`
`zugferdMetaData`	Nur zum Erstellen verwendbar. Beinhaltet ZUGFeRD- relevante Metadaten und setzt sich aus vier Parametern zusammen: `DocumentFileName` `ConformanceLevel` `DocumentType` `Version` Beim Schreiben werden die ZUGFeRD-Metadaten in das PDF/A-3-Dokument geschrieben.	`<Property name="zugferdMetaData" type="Map"> <Property name="ConformanceLevel">BASIC</Property> <Property name="DocumentFileName">ZUGFeRD-invoice.xml</Property> <Property name="DocumentType">INVOICE</Property> <Property name="Version">1.0</Property> </Property>`
`extractAllMetaData`	Zum Auslesen und Erstellen verwendbar. `true` - Alle XMP-Metadaten des PDF-Dokuments werden in der Variable `zugferdPdfMetaData` zurückgeliefert (zusätzlich zu den 4 ZUGFeRD-Metadaten). `false` - Es werden nur die 4 ZUGFeRD-Metadaten zurückgeliefert.	`false`
`zugferdNamespace`	Zum Auslesen und Erstellen verwendbar. Namespace von ZUGFeRD-Metadaten	`urn:ferd:pdfa:CrossIndustryDocument:invoice:1p0#`
`validateInputPdf`	Nur zum Erstellen verwendbar. `true` - Es wird geprüft, ob die Eingangsnachricht ein PDF/ A-1-Dokument ist. `false` - PDF/A-1-Prüfung wird ignoriert.	`true`
`invoice`	Pflichteigenschaft - muss gesetzt werden! Nur zum Erstellen verwendbar. Beinhaltet die `ZUGFeRD-invoice.xml`.

pluginType

Zum Auslesen und Erstellen verwendbar. Legt fest, ob ZUGFeRD gelesen oder geschrieben wird:

0 - Lesen

1 - Schreiben

0

validateInvoice

Zum Auslesen und Erstellen verwendbar.

true - Die ZUGFeRD-invoice.xml wird nach dem Schema ZUGFeRD_1p0.xsd validiert.

false - Es erfolgt keine Validierung der ZUGFeRD-invoice.xml.

false

zugferdMetaData

Nur zum Erstellen verwendbar. Beinhaltet ZUGFeRD- relevante Metadaten und setzt sich aus vier Parametern zusammen:

DocumentFileName
ConformanceLevel
DocumentType
Version

Beim Schreiben werden die ZUGFeRD-Metadaten in das PDF/A-3-Dokument geschrieben.

<Property name="zugferdMetaData" type="Map">
  <Property name="ConformanceLevel">BASIC</Property>
  <Property name="DocumentFileName">ZUGFeRD-invoice.xml</Property>
  <Property name="DocumentType">INVOICE</Property>
  <Property name="Version">1.0</Property>
</Property>

extractAllMetaData

Zum Auslesen und Erstellen verwendbar.

true - Alle XMP-Metadaten des PDF-Dokuments werden in der Variable zugferdPdfMetaData zurückgeliefert (zusätzlich zu den 4 ZUGFeRD-Metadaten).

false - Es werden nur die 4 ZUGFeRD-Metadaten zurückgeliefert.

false

zugferdNamespace

Zum Auslesen und Erstellen verwendbar. Namespace von ZUGFeRD-Metadaten

urn:ferd:pdfa:CrossIndustryDocument:invoice:1p0#

validateInputPdf

Nur zum Erstellen verwendbar.

true - Es wird geprüft, ob die Eingangsnachricht ein PDF/ A-1-Dokument ist.

false - PDF/A-1-Prüfung wird ignoriert.

true

invoice

Pflichteigenschaft - muss gesetzt werden! Nur zum Erstellen verwendbar. Beinhaltet die ZUGFeRD-invoice.xml.

Bei der Ausführung des ZUGFeRD Utilities werden die folgenden Modulvariablen als Ausgangsvariablen gesetzt und stehen im weiteren Ablauf des Workflows zur Verfügung:

Name Erklärung/Wert

Name	Erklärung/Wert
`zugferdPdfMetaData`	Falls die Variable `extractAllMetaData` gesetzt ist, enthält die Ausgangsvariable alle XMP-Metadaten des Dokuments.
`zugferdMetaData`	Die Variable beinhaltet ZUGFeRD-relevante Metadaten und setzt sich aus vier Parametern zusammen: `DocumentFileName` `ConformanceLevel` `DocumentType` `Version`

zugferdPdfMetaData

Falls die Variable extractAllMetaData gesetzt ist, enthält die Ausgangsvariable alle XMP-Metadaten des Dokuments.

zugferdMetaData

Die Variable beinhaltet ZUGFeRD-relevante Metadaten und setzt sich aus vier Parametern zusammen:

DocumentFileName
ConformanceLevel
DocumentType
Version

Um die Ausgangsvariablen im nachfolgenden Workflow nutzen zu können, müssen Sie die entsprechenden Modulvariablen im Variablen-Mapping des nachfolgenden Moduls definieren wie es im Kapitel Workflow-Variablen und Mappings beschrieben ist.

Für Informationen über Variablen und deren Verwendung, siehe Workflow-Variablen und Mappings.

ZUGFeRD-Datei auslesen

Sie können mit dem INUBIT ZUGFeRD Utility empfangene, ZUGFeRD-konforme Rechnungen auslesen und Rechnungsdaten sowie Metadaten in den Workflow weitergeben.

Voraussetzungen

Sie haben eine ZUGFeRD PDF/A-3-Datei, z.B. über einen File Connector, im Workflow verfügbar gemacht.

So gehen Sie vor

Binden Sie ein ZUGFeRD-Modul in Ihren Workflow ein.
Öffnen Sie über das Kontextmenü das Modul zum Bearbeiten.
Öffnen Sie im Eigenschaften-Dialog die Seite Einstellungen.
Aktivieren Sie die Option ZUGFeRD-Datei auslesen und XML-Rechnungsdaten extrahieren.
Optional: Falls ein anderer als der Standard-ZUGFeRD-Namespace in Ihrer Nachricht verwendet wird, aktivieren Sie die Option Standard ZUGFeRD Namespace überschreiben und geben Sie den Namespace im entsprechenden Feld ein.
Optional: Falls Sie die Rechnungsdaten in der ZUGFeRD-invoice.xml validieren möchten, aktivieren Sie die entsprechende Option.
Optional: Falls Sie zusätzlich zu den ZUGFeRD-Metadaten auch alle anderen auslesen möchten, aktivieren Sie die entsprechende Option.
Wenn Sie alle gewünschten Optionen zum Auslesen gesetzt haben, klicken Sie auf Fertig stellen.

Die Ausgangsnachricht enthält die ZUGFeRD-invoice.xml. Die Workflowvariable zugferdPdfMetaData mit Metadaten steht nach der Modulausführung automatisch zur Verfügung, falls die Moduleigenschaft extractAllMetaData gesetzt wurde (siehe Moduleigenschaften und -variablen des ZUGFeRD Utility).

ZUGFeRD-Datei erstellen

Im Folgenden wird beschrieben, wie im Workflow mit dem ZUGFeRD Utility Rechnungen erstellt werden, die dem ZUGFeRD-Standard entsprechen.

Voraussetzungen

Sie haben mithilfe z.B. eines FO Converters (siehe FO Converter) eine Eingangsnachricht erstellt.
Das Eingangsdokument (PDF) für die Erzeugung eines ZUGFeRD-Dokuments liegt im PDF/A-1 Format vor.
Die Eingangsnachricht für das ZUGFeRD Utility enthält das PDF/A-1-Dokument, eine XML-Workflowvariable mit dem Inhalt der ZUGFeRD-invoice.xml und eine XML-Workflowvariable mit Metadaten.

So gehen Sie vor

Binden Sie ein ZUGFeRD-Modul in Ihren Workflow ein.
Öffnen Sie über das Kontextmenü das Modul zum Bearbeiten.
Öffnen Sie im Eigenschaften-Dialog die Seite Einstellungen.
Aktivieren Sie die Option ZUGFeRD-Datei erstellen.
Optional: Falls Sie prüfen wollen, ob das Eingangsdokument dem Format PDF/A-1 entspricht, aktivieren Sie Eingelesenes PDF validieren.
Optional: Aktivieren Sie ggf. die Optionen in den Bereichen Namespace und Weitere Optionen (siehe Dialog ZUGFeRD-Einstellungen).
Wenn Sie alle gewünschten Optionen zum Erstellen gesetzt haben, klicken Sie auf Fertig stellen.
Um die Variablen invoice und zugferdMetaData zu füllen, müssen Sie entsprechende Abbildungsregeln im Variablen-Mapping anlegen. Öffnen Sie dazu am ZUGFeRD-Modul das Variablen-Mapping (siehe Workflow-Variablen und Mappings).
Erstellen Sie Ihre Abbildungsregel zum Befüllen der Variablen (siehe Abbildungsregeln für das Variablen-Mapping erstellen), nutzen Sie dabei als Ziel Moduleigenschaft und wählen Sie die gewünschte Variable.
Wenn Sie die Abbildungsregeln erstellt haben, klicken Sie OK. Der Mapping-Dialog schließt sich.

Die Ausgangsnachricht enthält die ZUGFeRD-PDF/A-3-Datei mit eingebetteten XML-Rechnungsdaten und XML-Metadaten.

Dialog ZUGFeRD-Einstellungen

In diesem Dialog legen Sie die Funktionsweise bzw. den gewünschten Verarbeitungsmodus des ZUGFeRD Utilitys und entsprechende Optionen fest.

ZUGFeRD-Version (nur für den Modus "Erstellen")

Wählen Sie die zum Erstellen der ZUGFeRD-Datei zu verwendende ZUGFeRD-Standard-Version.

Im Modus Auslesen wird die ZUGFeRD-Version automatisch erkannt.

Verarbeitungsmodus

ZUGFeRD-Datei auslesen und XML-Rechnungsdaten extrahieren

Mit dieser Option aktivieren Sie das Auslesen von importierten ZUGFeRD-PDF/A-3-Dokumenten und das Extrahieren der ZUGFeRD-invoice.xml sowie die Weitergabe der Metadaten als Workflow-Variable.
ZUGFeRD-Datei erstellen

Mit dieser Option aktivieren Sie das Erstellen von ZUGFeRD-Dateien, indem aus einem eingehenden PDF/A-1- Dokument, einer Workflow-Variablen als ZUGFeRD-invoice.xml und einer Workflow-Variablen mit Metadaten ein ZUGFeRD-PDF/A-3-Dokument erzeugt wird.
Eingelesenes PDF validieren (nur im ZUGFeRD-Datei erstellen-Modus)

Die Option validiert, ob das Eingangsdokument dem Format PDF/A-1 entspricht. In diesem Format muss die Eingangsnachricht vorliegen, um ein ZUGFeRD-PDF/A-3-Dokument erstellen zu können.

Namespace

Standard ZUGFeRD-Namespace überschreiben

Markieren Sie diese Option, falls die ZUGFeRD-Metadaten nicht unter dem Standard-Namespace adressiert werden.
ZUGFeRD-Namespace

Geben Sie hier den vom Standard-Namespace abweichenden Namespace ein.

Sobald Sie diese Option nach Aktivierung wieder deaktivieren, wird der manuell eingegebene Namespace überschrieben und der Standardwert gesetzt.

Weitere Optionen

Rechnungsdaten (ZUGFeRD-invoice.xml) validieren

Validiert die in der ZUGFeRD-invoice.xml eingebetteten Rechnungsdaten gegen das entsprechende Schema.
Alle Metadaten auslesen

Aktivieren Sie diese Option, wenn Sie nicht nur die ZUGFeRD-Metadaten, sondern alle Metadaten auslesen wollen.