zugferd.h File Reference

ZUGFeRD/Factur-X hybrid invoice PDF creation API. More...

#include <pdfsdk/core.h>

Go to the source code of this file.

Classes
struct	ZUGFeRDAttachment
	An additional file to embed alongside the invoice XML. More...
struct	ZUGFeRDConvertParams
	Parameters for ZUGFeRD/Factur-X creation. More...

Macros
#define	PDF_ZUGFERD_API   PDFSDK_IMPORT_

Enumerations
enum	ZUGFeRDVersion { kZUGFeRDVersion_ZF1p0 = 0 , kZUGFeRDVersion_ZF2p0 = 1 , kZUGFeRDVersion_FX1p0 = 2 }
	Invoice format family and version selector. More...
enum	ZUGFeRDProfile {   kZUGFeRDProfile_Minimum = 0 , kZUGFeRDProfile_BasicWL = 1 , kZUGFeRDProfile_Basic = 2 , kZUGFeRDProfile_Comfort = 3 ,   kZUGFeRDProfile_EN16931 = 3 , kZUGFeRDProfile_Extended = 4 , kZUGFeRDProfile_XRechnung = 5 }
	ZUGFeRD/Factur-X conformance profile. More...

Functions
PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV	PDFCreateZUGFeRD (PDDoc source, const PDProgressMonitor *progress, void *progressData, const ZUGFeRDConvertParams *params)
	Creates a ZUGFeRD/Factur-X hybrid invoice PDF/A-3b document.

Detailed Description

ZUGFeRD/Factur-X hybrid invoice PDF creation API.

Enumeration Type Documentation

ZUGFeRDProfile

enum ZUGFeRDProfile

ZUGFeRD/Factur-X conformance profile.

Enumerator
kZUGFeRDProfile_Minimum	MINIMUM (Factur-X only)
kZUGFeRDProfile_BasicWL	BASIC WL (without line items)
kZUGFeRDProfile_Basic	BASIC
kZUGFeRDProfile_Comfort	EN 16931 / COMFORT
kZUGFeRDProfile_EN16931	EN 16931 / COMFORT
kZUGFeRDProfile_Extended	EXTENDED
kZUGFeRDProfile_XRechnung	XRECHNUNG (German public sector)

ZUGFeRDVersion

enum ZUGFeRDVersion

Invoice format family and version selector.

ZF1p0 -> ZUGFeRD 1.0 ZF2p0 -> ZUGFeRD 2.0 FX1p0 -> Factur-X 1.0.8 / ZUGFeRD 2.4

Enumerator
kZUGFeRDVersion_ZF1p0	ZUGFeRD 1.0.
kZUGFeRDVersion_ZF2p0	ZUGFeRD 2.0.
kZUGFeRDVersion_FX1p0	Factur-X 1.0.8 / ZUGFeRD 2.4.

Function Documentation

PDFCreateZUGFeRD()

PDFSDK_IMPORT_ PDErrCode PDFSDK_CALLCONV PDFCreateZUGFeRD	(	PDDoc	source,
		const PDProgressMonitor *	progress,
		void *	progressData,
		const ZUGFeRDConvertParams *	params )

Creates a ZUGFeRD/Factur-X hybrid invoice PDF/A-3b document.

The source PDF is converted to PDF/A-3b. The invoice XML is embedded. The ZUGFeRD/Factur-X XMP extension schema and invoice metadata properties are written to the document XMP. Any additional attachments are also embedded.

Ownership: source is not modified and not retained; the caller remains responsible for closing it.

Parameters

source	Source PDF document. Must not be null.
progress	Optional progress monitor. May be null.
progressData	Opaque pointer forwarded to progress callbacks. May be null.
params	Conversion parameters. Must not be null.

Returns

kPDErrSuccess on success, or an error code on failure.