ZUGFeRD

webPDF supports the embedding of XML data according to the ZUGFeRD 1.0 and ZUGFeRD 2.x specification or the ZUGFeRD 2.x compatible Factur-X for PDF/A conversion.

After a successful check for validity of the XML (invoice) data, it is embedded in the PDF and output as a ZUGFeRD-compliant PDF/A-3.

Data embedding

You can use the parameters to specify the XML data for the ZUGFeRD file when calling the pdfa web service.

{
  "pdfa": {
    "convert": {
      "autoTagging": false,
      "errorCorrection": {
        "enabled": false
      },
      "errorReport": "none",
      "imageQuality": 75,
      "level": "1a",
      "successReport": "none",
      "zugferd": {
        "xmlFile": {
          "value": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCg0KPHBy...<BASE64>",
          "version": "v10Comfort"
        }
      }
    }
  }
}

If the zugferd element is defined in the pdfa object, the web service will embed the xmlFile file (Base64-encoded in zugferd.xmlFile.value) during the PDF/A conversion. Before being embedded, the XML data will be validated against the relevant schema and will only be embedded if valid. The schema version can be defined with the zugferd.xmlFile.version attribute in the parameters.

Supported schemas

Validation for the following ZUGFeRD schemas is supported:

• Version 1.0 (Comfort)
• Version 2.0 (Minimum profile, Basic WL profile, Basic profile, EN16931 (Comfort) profile, Extended profile
• Version 2.1, Version 2.2., Version 2.3 (Profil Minimum, Profil Basic WL, Profil Basic, Profil EN16931 (Comfort), Profil Extended, Profil X-Rechnung) [^1]

Since version 2.1.1 the profile XRechnung is also supported.

note

The ZUGFeRD 2.x standard supports the XRechnung and Factur-X 1.0 standard developed as part of the German-French Digital Agenda. This means that all requirements according to the complete EU standard of EN 16931 are also met. ZUGFeRD 2.x fulfills all requirements of the EU Directive 2014/55/EU for XRechnung and can be used for invoicing with authorities, nationally and internationally.

For more information on ZUGFeRD and the structure of the XML file and its use, please visit https://www.ferd-net.de.

note

ZUGFeRD 2.1.x and Factur-X 1.0 continue to be fully compatible and technically identical formats, which will already share the Factur-X identifier as of March 24, 2020.