Key Capabilities
- German e-invoicing standard combining PDF and XML with bidirectional processing (extract XML or generate ZUGFeRD files)
- Support for versions 1.0, 2.0, 2.1 with multiple conformance levels (MINIMUM, BASIC, EN 16931, EXTENDED, and XRECHNUNG)
- PDF/A-3 format support for embedding machine-readable XML in human-readable PDFs with Batch Group processing
Overview
The ZUGFeRD connector facilitates the exchange of electronic invoices by integrating the ZUGFeRD (Zentraler User Guide des Forums elektronische Rechnung Deutschland) standard, which combines human-readable and machine-readable data in a single document. It is based on the PDF/A-3 standard, which allows for the embedding of XML data in a PDF file. This hybrid format ensures that the invoice can be easily read by humans while also being processed automatically by computer systems. The ZUGFeRD connector allows you to interact with ZUGFeRD files in two ways: The connector determines which to do based on the type of input provided.Connector Configuration
This section contains all of the configurable connector properties.Settings Tab
Configuration
Settings related to establishing the connection.| Setting | Description |
|---|---|
| Connector Id | The static, unique identifier for the connector. |
| Connector Type | Displays the connector name and a description of what it does. |
| Connector Description | An optional field to provide a free-form description of the connector and its role in the flow. |
| Version | The ZUGFeRD version to use in the generated ZUGFeRD file. |
Advanced Settings
Settings not included in the previous categories.| Setting | Description |
|---|---|
| Conformance Level | The conformance level to use in the generated ZUGFeRD file. Options are: BASIC, EXTENDED, MINIMUM, BASIC WL, EN 16931, XRECHNUNG. |
| Invoice Description | The free text description to use in the generated ZUGFeRD file. |
Advanced Tab
Logging
Other Settings
| Setting | Description |
|---|---|
| Processing Delay | The amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting. |
Miscellaneous
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.| Setting | Description |
|---|---|
| Send | Check this to have the connector automatically send files when they are ready. |
Performance
Alerts Tab
SLAs Tab
Parsing a ZUGFeRD file
The connector expects to receive a PDF file as input, which it reads to extract the attached XML to send down the flow.Handling Multiple Attachments
You might receive PDF files containing multiple attachments. By default, the connector passes all the attachments down the flow, adding headers to each message:- ZUGFeRD-File-Index: The attachment number for each attachment
- ZUGFeRD-File-Count: The total number of attachments on the email
- ZUGFeRD-File-Name: The original PDF file name
- ZUGFeRD-File-Description: The description of invoice XML and attachments
- ZUGFeRD-File-Parameters: Other file parameters of invoice XML and attachments
- ZUGFeRD-File-Relationship: The file relationship of invoice xml and attachments. Invoice XML is usually “Alternative”, and attachments are “Data”, “Supplement”, and so on.
- ZUGFeRD-File-Subtype: The file subtype of invoice xml and attachments. This is usually the MIME-Type of the file, such as text\xml or application\pdf.
Generating a ZUGFeRD file
The connector expects a Batch Group containing exactly one PDF Batch Message and exactly one XML Batch Message. Use the Batch Create connector to create these Batch Groups before sending them to the ZUGFeRD connector in your flow. If you include more than one PDF or XML Batch Message, or if either is missing in the Batch Group, an error is thrown. All of the ZUGFeRD specific settings in the UI (Version, Conformance Level, and Invoice Description) are only used to generate a ZUGFeRD file. Parsing does not involve these settings at all.- Version: Controls the ZUGFeRD version used when generating files. supports versions 1.0, 2.0, and 2.1.
-
Conformance Level: The ZUGFeRD standard primarily includes the following conformance levels:
-
MINIMUM
- Contains the most basic invoice information, such as invoice number, date, and amount.
- Data is embedded in PDF/A-3 format, facilitating human readability and simple system processing.
-
BASIC
- Builds upon the MINIMUM level by including more structured data, such as buyer and seller details, tax information, and payment terms.
- Suitable for scenarios requiring moderate automation.
-
BASIC WL
- Similar to BASIC but tailored for specific use cases, often including additional fields for certain industries or regions.
- Enhances interoperability in specialized contexts.
-
EN 16931 (COMFORT)
- Complies with the EU standard EN 16931, providing complete structured data for highly automated processing.
- Ideal for complex business processes and system integration.
-
EXTENDED
- Expands on EN 16931 by allowing the inclusion of industry- or company-specific additional information.
- Designed for businesses with unique requirements.
-
XRECHNUNG
- A German-specific profile based on ZUGFeRD, aligned with the XRechnung standard for public sector invoicing.
- Ensures compliance with German public procurement regulations.
-
MINIMUM
- Invoice Description: PDF readers surface an optional description for attachments on PDFs. This setting controls what description is used for the XML attachment.
Generating a Sample File
To generate a sample file that you can use for testing, navigate to the connector’s Transactions tab and click the Generate sample file
button. This creates a PDF file in the Send folder. When the connector processes the PDF, it generates an XML output file with the extracted invoice data from the PDF.