CIB ZUGFERD SDK TECHNISCHE DOKUMENTATION

Transkript

1 > Technical Support & Services CIB ZUGFERD SDK TECHNISCHE DOKUMENTATION Technical Support & Services > Stand: 28. Januar 2014 Version 1.03

2 CIB software GmbH > Technical Support & Services > CIB ZUGFeRD SDK > Dokument DOKUMENT CIBZugferdSDKDokumentation.docx, vom :06:00 Autor: Thema: CIB software GmbH CIB ZUGFeRD SDK Technische Dokumentation Technical Support & Services Copyright: Status: CIB software GmbH, Elektrastraße 6a, München gültig 2 11

3 CIB software GmbH > Technical Support & Services > CIB ZUGFeRD SDK > Versionshistorie VERSIONSHISTORIE Datum Beschreibung Version Erstausgabe 1 / Ergänzung Rückgabewerte 1 / Anpassung in / Anpassung in /

4 INHALT 1 ZUGFERD DER NEUE STANDARD 5 2 DAS ZUGFERD SDK (SOFTWARE DEVELOPMENT KIT) Prüfen eines PDF-Dokuments als ZUGFeRD-Konform Extrahieren eines ZUGFeRD-XML Einbetten eines ZUGFeRD-XML Mögliche Rückgabewerte Testprogramm zum Testen des SDK Programmiersprachen und Systeme 8 3 DIE CIB PDF TOOLBOX ALS PDF WERKZEUGKASTEN 9 4 ALLGEMEINES Hinweis CIB Support Lizenzierung

5 1 ZUGFERD DER NEUE STANDARD Mit dem einheitlichen Datenformat-Standard ZUGFeRD (Zentraler User Guide des Forum elektronische Rechnung Deutschland ) können elektronische Rechnungen zwischen Unternehmen sowie zwischen Unternehmen und der öffentlichenverwaltung schnell, komfortabel und einfach ausgetauscht werden. Der Standard basiert auf einer XML-Datei mit maschinenlesbaren Informationen, die über den Rechnungsdatenteil in ein PDF/A3-Dokument eingebettet wird. Somit wird elektronisch geprüft, ob das eingehende Dokument eine Rechnung darstellt und welche Rechnungsposten darin enthalten sind. Zudem kann automatisch ein Verarbeitungsprozess für eine Rechnung gestartet und zwischen verschiedenen Softwarelösungen ohne erneute Datenerfassung ausgetauscht werden. Mehr Informationen zu ZUGFeRD finden Sie auf der Website von FeRD,

6 2 DAS ZUGFERD SDK (SOFTWARE DEVELOPMENT KIT) Das SDK dient dazu, die grundsätzliche Kompatibilität eines PDF-Dokuments zum ZUGFeRD- Standard zu prüfen und den XML-Rechnungsdatensatz aus der PDF-Datei zu extrahieren. Die extrahierten XML-Daten stehen dann zur weiteren Verarbeitung z.b. durch ein ERP-System zur Verfügung. So können Sie die extrahierte XML-Datei in ein existierendes PDF einbetten. Das CIB ZUGFeRD SDK bietet die folgenden drei API Funktionen an. 2.1 PRÜFEN EINES PDF-DOKUMENTS ALS ZUGFERD-KONFORM int CibZugferdSDKIsZugferd(const char* pdffile); Die Funktion CibZugferdSDKIsZugferd prüft, ob das angegebene Dokument dem ZUGFeRD- Standard entspricht und eine Rechnung mit ZUGFeRD Informationen vorliegt. Rückgabewerte: Wert ERR_ZUGFERD_OK_HAS_ZUGFERD ERR_ZUGFERD_OK_NO_ZUGFERD Bedeutung Die vorliegende PDF Datei ist ZUGFeRD kompatibel. Die vorliegende PDF Datei ist nicht ZUGFeRD kompatibel. Wenn es innerhalb des SDK zu einer Fehlersituation gekommen ist, wird ein anderer ERR_ZUGFERD Wert zurückgegeben. Die Fehlerwerte und ihre Bedeutung entnehmen Sie der Datei CibZugferdSDK.h. 2.2 EXTRAHIEREN EINES ZUGFERD-XML int CibZugferdSDKExtraxt(const char* inputpdffile, const char* outputxmlfile, bool check); Die Funktion CibZugferdSDKExtraxt extrahiert aus einem angegebenen Dokument das XML des ZUGFeRD-Standards. Mit Eingabe der Variablen check können Sie prüfen, ob die ZUGFeRD-XML Datei dabei dem ZUGFeRD-Schema entspricht. Es werden keine Ausgabedateien überschrieben, wenn diese bereits vorhanden sein sollten. Rückgabewert: Wert ERR_ZUGFERD_OK Bedeutung Aus der vorliegenden PDF Datei wurde das XML des ZUGFeRD-Standards erfolgreich extrahiert. Wenn es innerhalb des SDK zu einer Fehlersituation gekommen ist, wird ein anderer ERR_ZUGFERD Wert zurückgegeben. Die Fehlerwerte und ihre Bedeutung entnehmen Sie der Datei CibZugferdSDK.h. 6 11

7 2.3 EINBETTEN EINES ZUGFERD-XML int CibZugferdSDKEmbed(const char* inputpdffile, const char* inputxmlfile, const char* outputpdffile, bool check, const char* description); Die Funktion CibZugferdSDKEmbed bettet in einem angegebenen Dokument die existierende XML-Datei des ZUGFeRD-Standards ein. Mit Eingabe der Variablen check können Sie prüfen, ob die ZUGFeRD-XML Datei dabei dem ZUGFeRD-Schema entspricht. Es werden keine Ausgabedateien überschrieben, wenn diese bereits vorhanden sein sollten. Rückgabewert: Wert ERR_ZUGFERD_OK Bedeutung Aus der vorliegenden PDF Datei wurde das XML des ZUGFeRD-Standards erfolgreich eingebettet. Wenn es innerhalb des SDK zu einer Fehlersituation gekommen ist, wird ein anderer ERR_ZUGFERD Wert zurückgegeben. Die Fehlerwerte und ihre Bedeutung entnehmen Sie der Datei CibZugferdSDK.h. 2.4 MÖGLICHE RÜCKGABEWERTE In der nachfolgenden Tabelle sind die in ZUGFeRD vorhandenen Fehler-Rückgabewerte und ihre Bedeutung aufgelistet: Fehler-Nr. Meldung Bedeutung 0 ERR_ZUGFERD_OK Kein Fehler aufgetreten ERR_ZUGFERD_UNSPECIFIC Nichtspezifizierter Fehler aufgetreten ERR_ZUGFERD_OUTPUTFILE_EXITS Angegebene Ausgabedatei ist bereits vorhanden und kann nicht überschrieben werden ERR_ZUGFERD_READ Fehler beim Lesen aufgetreten ERR_ZUGFERD_INPUT Fehler bei den Eingabeparametern aufgetreten ERR_ZUGFERD_NO_PDFA3_INPUT Es wurde keine PDF/A3-Datei beim Einbetten angegeben ERR_ZUGFERD_ALREADY_EMBEDDED Eine bereits eingebettete ZUGFeRD-XML wurde erneut in die Datei eingebettet ERR_ZUGFERD_EXTRACTING Fehler beim Extrahieren ERR_ZUGFERD_SCHEMA ZUGFeRD-XML entspricht nicht dem ZUGFeRD- Schema oder das ZUGFeRD-Schema wurde nicht gefunden. Tab. 1 ZUGFeRD - Rückgabewerte 7 11

8 2.5 TESTPROGRAMM ZUM TESTEN DES SDK Im Lieferumfang ist ein Testprogramm enthalten, dass das SDK testet. Wenn Sie das Testprogramm mit dem Parameter? aufrufen, erhalten Sie eine Beschreibung der möglichen Aufrufparameter. 2.6 PROGRAMMIERSPRACHEN UND SYSTEME Das CIB ZUGFeRD SDK bietet ein C-Programmierinterface an. Für Java und C# werden Programmierschnittstellen mitgeliefert. Das SDK ist in 32 bit und 64 bit für Windows erhältlich. Weitere Informationen zu anderen Programmiersprachen und Systemen (Linux / Android) erhalten Sie beim CIB Support. 8 11

9 3 DIE CIB PDF TOOLBOX ALS PDF WERKZEUGKASTEN Das CIB ZUGFeRD SDK nutzt die CIB pdf toolbox, um Informationen über das PDF auszulesen und die Bearbeitungen am PDF durchzuführen. Über die CIB ZUGFeRD SDK Möglichkeiten hinaus ist die CIB pdf toolbox eine sehr reichhaltige Bibliothek zur Bearbeitung von PDF Dokumenten. Unter anderem bietet die CIB pdf toolbox folgende Funktionen an: Auslesen von generellen Informationen über PDFs Zusammenführen und teilen von PDFs Löschen von Seiten Barcodes aufbringen und auslesen Briefpapiere oder Overlaybilder/Texte hinterlegen oder aufbringen Formularfeldinformationen auslesen, Formularfelder befüllen, Formularfelder flatten PDF signieren PDFs in Bilder rendern PDFs zu SVG/XPS/Postscript konvertieren PDF Signaturen entfernen oder validieren PDFs verschlüsseln oder entschlüsseln Bearbeiten von Lesezeichen PDFs durchsuchbar machen durch Texterkennung in Bildern PDFs drucken PDF/A1, PDF/A2 und PDF/A3 Konvertierung Textextraction aus PDFs mit Schablonen Angehängte Dateien einbringen oder auslesen PDF-Annotationen aufbringen oder auslesen Weitere Informationen über die CIB pdf toolbox und andere CIB Produkte zur Dokumentbearbeitung erhalten Sie beim CIB Support. 9 11

10 4 ALLGEMEINES 4.1 HINWEIS Copyright 2015 CIB software GmbH. Alle Rechte vorbehalten. Die CIB software GmbH behält sich sämtliche Eigentumsrechte an der angebotenen Software und der dazugehörigen Dokumentation vor. Die Benutzung der Software und des dazugehörigen Benutzerhandbuches unterliegen dem der Software zugrundeliegenden Lizenzvertrag. Die Bereitstellung und der Download dieses Dokuments und der Software allein bewirken keine Übertragung von Nutzungs- und Vervielfältigungsrechten. Kein Teil dieses Handbuchs darf ohne schriftliche Genehmigung der CIB software GmbH in irgendeiner Form reproduziert oder weiterverwertet werden. Auch eine Bearbeitung, insbesondere eine Übersetzung der Dokumentation, ist ohne Genehmigung der CIB software GmbH nicht gestattet. Der Inhalt dieses Handbuches ist auch urheberrechtlich geschützt, wenn es nicht mit der Software geliefert wird, die eine Endbenutzerlizenzvereinbarung enthält. CIB pdf brewer, CIB cosys, CIB webdesk, CIB workbench, CIB dialog, CIB merge, CIB view, CIB format, CIB print, CIB pdf toolbox sind entweder eingetragene Marken oder Marken der CIB software GmbH. Die angebotene Software enthält von der Apache Software Foundation entwickelte Software ( Windows ist eine eingetragene Marke der Microsoft Corporation. Solaris und Java sind Marken bzw. eingetragene Marken der Sun Microsystems, Inc. Inhalt und Struktur des ZUGFeRD Datenformats sind urheberrechtlich geschützt. Alle anderen Marken- und Produktnamen sind Marken oder eingetragene Marken der jeweiligen Rechteinhaber. Der Inhalt dieses Handbuchs wurde mit größter Sorgfalt erarbeitet. Die Angaben in diesem Handbuch gelten jedoch nicht als Zusicherung von Eigenschaften des Produktes. Die CIB software GmbH haftet nur im Umfang ihrer Verkaufs- und Lieferbedingungen und übernimmt keine Gewähr für technische Ungenauigkeiten und oder Auslassungen. Die CIB software GmbH haftet weder für technische oder typographische Fehler und Mängel in diesem Handbuch, noch für Schäden, die direkt oder indirekt auf die Lieferung, Leistung und Nutzung dieses Materials zurückzuführen sind. Die Informationen in diesem Handbuch können ohne Ankündigung geändert werden

11 4.2 CIB SUPPORT Sollten während des Einsatzes Unstimmigkeiten in Zusammenhang mit den Ausführungen in dieser Übersicht auftreten, sind wir Ihnen für entsprechende Hinweise sehr dankbar: CIB software GmbH Elektrastraße 6a München Tel.: 49 (0)89 / Fax: 49 (0)89 / LIZENZIERUNG Dieses Dokument gibt keine Hinweise zur Lizenzierung. Detaillierte Informationen zu Lizenzierung und den Lizenzmodellen erhalten Sie von den Mitarbeitern des CIB Vertriebs