Skip to main content
Version: 9.0

ZUGFeRD

webPDF supports the embedding of XML data according to the ZUGFeRD 1.0, ZUGFeRD 2.0 and ZUGFeRD 2.1.1 specification or the Factur-X compatible with ZUGFeRD 2.1 for PDF/A conversion.

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, the web service will embed the xmlFile file (Base64-encoded) 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 version attribute in the parameters.

Validation against the following schemas is supported:

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

[^1] currently corresponds to version 2.1.1 from 01.07.2020

Since version 2.1.1 the profile XRechnung is also supported. For more information on ZUGFeRD and the structure of the XML file and its use, please visit https://www.ferd-net.de.

note

The ZUGFeRD 2.0 standard also supports the XRechnung standard, as well asFactur-X 1.0 with the corresponding interaction.

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.