Zum Hauptinhalt springen

ZUGFeRD

webPDF unterstützt bei der PDF/A-Konvertierung die Einbettung von XML-Daten gemäß der Spezifikation ZUGFeRD 1.0, ZUGFeRD 2.0 und ZUGFeRD 2.1.1 bzw. das zu ZUGFeRD 2.1 kompatible Factur-X.

Beim Aufruf des Webservice "Pdfa" können in den Parametern die XML-Daten für die ZUGFeRD-Datei angegeben werden.

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

Wird das Element "zugferd" definiert, so wird vom Webservice die Datei "xmlFile" (BASE64 encoded) bei der PDF/A-Konvertierung eingebettet. Die XML-Datei wird vor der Einbettung gegen das entsprechende Schema geprüft und nur bei Gültigkeit eingebettet. Die Schema-Version wird über das Attribut "version" in den Parametern definiert.

Unterstützt wird die Validierung gegen die folgenden Schemas:

  • Version 1.0 - Comfort
  • Version 2.0 - Profil Minimum
  • Version 2.0 - Profil Basic WL
  • Version 2.0 - Profil Basic
  • Version 2.0 - Profil EN16931 (Comfort)
  • Version 2.0 - Profil Extended
  • Version 2.1 - Profil Minimum*
  • Version 2.1 - Profil Basic WL*
  • Version 2.1 - Profil Basic*
  • Version 2.1 - Profil EN16931 (Comfort)*
  • Version 2.1 - Profil Extended*
  • Version 2.1 - Profil X-Rechnung*
  • entspricht aktuell der Version 2.1.1 vom 01.07.2020

Seit der Version 2.1.1 wird auch das Profil "X-Rechnung" unterstützt. Weitere Informationen zu ZUGFeRD und den Aufbau der XML-Datei bzw. deren Verwendung finden Sie auf https://www.ferd-net.de.

Hinweis

Die Norm ZUGFeRD 2.0 unterstützt auch den Standard XRechnung und durch eine entsprechende Zusammenarbeit auch Factur-X 1.0.

Hinweis

ZUGFeRD 2.1.x und Factur-X 1.0 sind weiterhin vollständig kompatible und technisch identische Formate, die bereits ab dem 24. März 2020 gemeinsam die Kennung Factur-X nutzen.