Column	Description
Property Name	The name of the property which is used in the ZUGFeRD JavaScript API.
Description	Description of the element as well as possible values.
Required for	Describes for which element this element has to be specified to generate the element, if any. If in this field "ZUGFeRD" is written, the ZUGFeRD PDF cannot be generated without this property.
Profile	The ZUGFeRD profile in which the ZUGFeRD property is occurring. If in the ZUGFeRD JavaScript API the profile basic has been set, elements that require the profile comfort will not be created. However in comfort, ZUGFeRD properties which require the profile basic are allowed.
Type	The type of the ZUGFeRD property. Depending on the type, the value has to meet special criteria.

Property Name Description Required Profile Type

zugferd-profile The profile of the ZUGFeRD invoice. Possible values are basic and comfort. yes basic Text

document-id The invoice number. yes basic Text

document-name The document type, "invoice" for example. yes basic Text

document-type The document type defined by a ZUGFeRD code, which should match the document-name. For the profile basic, only the ZUGFeRD code 380 is allowed. yes basic Document Type

document-issue-date The invoice date. yes basic Date

seller-name Seller name. yes basic Text

buyer-name Buyer name. yes basic Text

currency The currency of the document as code e.g. GBP, USD. yes basic Currency Code

line-total Total amount for all positions. yes basic Number

tax-basis-total Total amount for the tax basis. yes basic Number

tax-total Tax total amount, calculated from the tax-basis-total. yes basic Number

grand-total Total amount with taxes. yes basic Number

test-indicator Specifies whether this ZUGFeRD XML has been generated for testing purposes only. The boolean has to be specified as string. basic Boolean

buyer-reference Buyer reference. comfort Text

delivery-date Delivery date. basic Date

reference-line Reference line. basic Text

payment-type Payment type as code e.g. "10" for cash. comfort Payment Code

payment-method Payment type as text. This should match the property payment-type. comfort Text

mandate-reference Mandate reference. comfort Text

mandate-reference-id Mandate identifier defined by the mandate. comfort Text

charge-total Total amount of all charges. If no charges have been applied, this element will be generated with an amount of 0.00. basic Number

allowance-total Total amount of all allowances. If no allowances have been applied, this element will be generated with an amount of 0.00. basic Number

prepaid-total Total prepaid amount. comfort Number

due-payable The due payable amount. comfort Number

document-note

Defines a note on document level. To create this element, the ZUGFeRD property document-note.content is required. Document Note is a repeating element.

Property Name	Description	Required	Profile	Type
document-note.content	The text content of a note on document level.	yes	basic	Text
document-note.subject-code	A ZUGFeRD code defining the type of the note.		comfort	Subject Code

Defines a note on document level. To create this element, the ZUGFeRD property document-note.content is required. Document Note is a repeating element.

basic

Repeating Element

seller

To define the seller, the following ZUGFeRD properties can be used. None of these ZUGFeRD properties are required to generate the seller element, except the seller-name, which is already required for ZUGFeRD.

Property Name	Description	Profile	Type
seller-id	Seller ID.	comfort	Text
seller-global-id	Seller global ID.	comfort	Global ID
seller-postcode	Seller postal code.	basic	Text
seller-lineone	Address line 1 of the Seller.	basic	Text
seller-linetwo	Address line 2 of the Seller.	basic	Text
seller-city	Seller city.	basic	Text
seller-country	Seller country code e.g. GB, US.	basic	Country Code
seller-vatid	Seller VAT ID.	basic	Text
seller-taxid	Seller Tax ID.	basic	Text

basic

Unique Element

buyer

To define the buyer, the following ZUGFeRD properties can be used. None of these ZUGFeRD properties are required to generate the buyer element, except the buyer-name, which is already required for ZUGFeRD.

Property Name	Description	Profile	Type
buyer-id	Buyer ID.	comfort	Text
buyer-global-id	Buyer global ID.	comfort	Global ID
buyer-postcode	Buyer postal code.	basic	Text
buyer-lineone	Address line 1 of the buyer.	basic	Text
buyer-linetwo	Address line 2 of the buyer.	basic	Text
buyer-city	Buyer city.	basic	Text
buyer-country	Buyer country code e.g. GB, US.	basic	Country Code
buyer-vatid	Buyer VAT ID of the buyer.	basic	Text
buyer-taxid	Buyer Tax ID.	basic	Text

basic

Unique Element

buyer-order-reference

Element to define the buyer order reference. To generate the reference, the ZUGFeRD property buyer-order-reference-id has to be specified.

Property Name	Description	Required	Profile	Type
buyer-order-reference-issue-date	Order date. Does not require an output format.		comfort	Date
buyer-order-reference-id	Order reference number.	yes	comfort	Text

Element to define the buyer order reference. To generate the reference, the ZUGFeRD property buyer-order-reference-id has to be specified.

comfort

Unique Element

contract-reference

Element to define the contract reference. To generate the reference, the ZUGFeRD property contract-reference-id has to be specified.

Property Name	Description	Required	Profile	Type
contract-reference-issue-date	Contract date. Does not require an output format.		comfort	Date
contract-reference-id	Contract number.	yes	comfort	Text

Element to define the contract reference. To generate the reference, the ZUGFeRD property contract-reference-id has to be specified.

comfort

Unique Element

customer-order-reference

Element to define the customer order reference. To generate the reference, the ZUGFeRD property customer-order-reference-id has to be specified.

Property Name	Description	Required	Profile	Type
customer-order-reference-issue-date	Customer order date. Does not require an output format.		comfort	Date
customer-order-reference-id	Customer order reference number.	yes	comfort	Text

Element to define the customer order reference. To generate the reference, the ZUGFeRD property customer-order-reference-id has to be specified.

comfort

Unique Element

delivery-note-reference

Element to define the customer order reference. To generate the reference, the ZUGFeRD property delivery-note-reference-id has to be specified.

Property Name	Description	Required	Profile	Type
delivery-note-reference-issue-date	Delivery note date. Does not require an output format.		comfort	Date
delivery-note-reference-id	Delivery note number.	yes	comfort	Text

Element to define the customer order reference. To generate the reference, the ZUGFeRD property delivery-note-reference-id has to be specified.

comfort

Unique Element

invoicee

To define the invoicee, the following ZUGFeRD properties can be used. To generate this element, the property invoicee-name has to be used. All other properties are optional.

Property Name	Description	Required	Profile	Type
invoicee-id	Invoicee ID.		comfort	Text
invoicee-global-id	Invoicee global ID.		comfort	Global ID
invoicee-name	Invoicee name.	yes	comfort	Text
invoicee-postcode	Invoicee postal code.		comfort	Text
invoicee-lineone	Invoicee address line 1.		comfort	Text
invoicee-linetwo	Invoicee address line 2.		comfort	Text
invoicee-city	Invoicee City.		comfort	Text
invoicee-country	Invoicee country code e.g. GB, US.		comfort	Country Code
invoicee-vatid	Invoicee VAT ID.		comfort	Text
invoicee-taxid	Invoicee Tax ID.		comfort	Text

To define the invoicee, the following ZUGFeRD properties can be used. To generate this element, the property invoicee-name has to be used. All other properties are optional.

comfort

Unique Element

payer

ZUGFeRD properties to define the bank details of the payer. All ZUGFeRD properties are optional.

Property Name	Description	Profile	Type
payer-iban	IBAN of the payer.	comfort	Text
payer-account-number	Payer account number.	comfort	Text
payer-bic	Payer BIC.	comfort	Text
payer-blz	German bankleitzahl of the payer.	comfort	Text
payer-bank	Name of the bank of the payer.	comfort	Text

ZUGFeRD properties to define the bank details of the payer. All ZUGFeRD properties are optional.

comfort

Unique Element

payee

ZUGFeRD properties to define the bank details of the payee. All ZUGFeRD properties are optional.

Property Name	Description	Profile	Type
payee-iban	Payee IBAN.	basic	Text
payee-account-name	Payee account name.	basic	Text
payee-account-number	Payee account number.	basic	Text
payee-bic	BIC of the payee.	basic	Text
payee-blz	German bankleitzahl of the payee.	basic	Text
payee-bank	Name of the payee's bank.	basic	Text

ZUGFeRD properties to define the bank details of the payee. All ZUGFeRD properties are optional.

basic

Unique Element

tax

These ZUGFeRD properties are used to define the in the PDF used taxes. To generate this element, the properties tax.calculated, tax.type, tax.basis are tax.percent required.

Property Name	Description	Required	Profile	Type
tax.calculated	Calculated tax amount.	yes	basic	Number
tax.type	Tax type.	yes	basic	Tax Type
tax.reason	Reason for tax exemption.		comfort	Text
tax.basis	Base amount for the tax calculation.	yes	basic	Number
tax.category	Tax category.		comfort	Tax Category
tax.percent	Applicable tax percentage.	yes	basic	Number

These ZUGFeRD properties are used to define the in the PDF used taxes. To generate this element, the properties tax.calculated, tax.type, tax.basis are tax.percent required.

basic

Repeating Element

billing-period

ZUGFeRD properties to define the billing period. Both properties are required to generate this element.

Property Name	Description	Required	Profile	Type
billing-period-start	Start of the billing period.	yes	comfort	Date
billing-period-end	End of the billing period.	yes	comfort	Date

ZUGFeRD properties to define the billing period. Both properties are required to generate this element.

comfort

Unique Element

allowance-charge

The following ZUGFeRD properties can be used to define an allowance or charge. The properties allowance-charge.indicator and allowance-charge.amount have to be used to generate the element. Allowance charge is a repeating element.

Property Name Description Required Profile Type

allowance-charge.indicator Indicator for allowances or charges. "true" defines an allowance. yes comfort Boolean

allowance-charge.amount Amount of this allowance or charge. yes comfort Number

allowance-charge.reason Reason for this allowance or charge. comfort Text

allowance-charge.tax

With this nested repeating element it is possible to define taxes for allowances or charges. The ZUGFeRD proeperties allowance-charge.tax.typ, allowance-charge.tax.category und allowance-charge.tax.percent are required to generate this element.

Property Name	Description	Required	Profile	Type
allowance-charge.tax.type	Tax type of this allowance or charge.	yes	comfort	Tax Type
allowance-charge.tax.category	Tax category of this allowance or charge.	yes	comfort	Tax Category
allowance-charge.tax.percent	Applicable tax percentage of this allowance or charge.	yes	comfort	Number

comfort

Repeating Element

comfort

Repeating Element

logistic-charge

It is possible to define logistic service charges with this repeating element. The ZUGFeRD properties logistic-charge.description and logistic-charge.amount are required to generate this element.

Property Name Description Required Profile Type

logistic-charge.description Service charge description. yes comfort Text

logistic-charge.amount Service charge amount. yes comfort Number

logistic-charge.tax

With this nested repeating element it is possible to define taxes for logistic service charges. The ZUGFeRD properties logistic-charge.tax.type, logistic-charge.tax.category and logistic-charge.tax.percent are required to generate this element.

Property Name	Description	Required	Profile	Type
logistic-charge.tax.type	Tax type of the service charge.	yes	comfort	Tax Type
logistic-charge.tax.category	Tax category of the service charge.	yes	comfort	Tax Category
logistic-charge.tax.percent	Applicable tax percentage of the service charge.	yes	comfort	Number

comfort

Repeating Element

It is possible to define logistic service charges with this repeating element. The ZUGFeRD properties logistic-charge.description and logistic-charge.amount are required to generate this element.

comfort

Repeating Element

payment-terms

To specify the payment terms, this repeating element can be used. To generate this element, the ZUGFeRD property payment-terms.description is required.

Property Name	Description	Required	Profile	Type
payment-terms.description	Payment terms text.	yes	comfort	Text
payment-terms.due-date	Payment due date.		comfort	Date

To specify the payment terms, this repeating element can be used. To generate this element, the ZUGFeRD property payment-terms.description is required.

comfort

Repeating Element

item

With this repeating element it is possible to define more information for this position. To generate this element, the ZUGFeRD property item.name is required.

Property Name Description Required Profile Type

item.seller-id Seller assigned product ID. comfort Text

item.buyer-id Buyer assigned product identifier. comfort Text

item.name Product name. yes basic Text

item.description Product description. comfort Text

item.line-total Total amount of this position. comfort Number

item.note

Defines a note for this position. To generate this element, the ZUGFeRD property item.note.conten is required.

Property Name	Description	Required	Profile	Type
item.note.content	Position text description.	yes	comfort	Text

Defines a note for this position. To generate this element, the ZUGFeRD property item.note.conten is required.

comfort

Repeating Element

item.gross-price

Element to define details on gross price without taxes. To generate this element, the ZUGFeRD property item.gross-price-amount is required.

Property Name

Description

Required

Profile

Type

item.gross-price-amount

Gross price for this position.

yes

comfort

Number

item.gross-price-quantity

Optional element to define the gross price basis quantity. All following ZUGFeRD properties are required to generate this element.

Property Name	Description	Required	Profile	Type
item.gross-price-quantity	Price basis quantity.	yes	comfort	Number
item.gross-price-quantity-unit	Unit for the price basis quantity.	yes	comfort	Quantity Unit

Optional element to define the gross price basis quantity. All following ZUGFeRD properties are required to generate this element.

comfort

Unique Element

Element to define details on gross price without taxes. To generate this element, the ZUGFeRD property item.gross-price-amount is required.

comfort

Unique Element

item.gross-price-allowance-charge

Nested repeating element to define an allowance or charge on the gross price. The ZUGFeRD properties item.gross-price-allowance-charge.indicator und item.gross-price-allowance-charge.amount have to be used to generate this element.

Property Name	Description	Required	Profile	Type
item.gross-price-allowance-charge.indicator	Indicator for allowances or charges. "`true`" defines an allowance.	yes	comfort	Boolean
item.gross-price-allowance-charge.amount	Amount of the allowance or charge.	yes	comfort	Number
item.gross-price-allowance-charge.reason	Reason for the allowance or charge.		comfort	Text

comfort

Repeating Element

item.net-price

Element to define details on net price without taxes. To generate this element the ZUGFeRD property item.net-price-amount is required.

Property Name

Description

Required

Profile

Type

item.net-price-amount

Net price for this position.

yes

comfort

Number

item.net-price-quantity

Optional element to define the net price basis quantity. All following ZUGFeRD properties are required to generate this element.

Property Name	Description	Required	Profile	Type
item.net-price-quantity	Price basis quantity.	yes	comfort	Number
item.net-price-quantity-unit	Unit of the price basis quantity.	yes	comfort	Quantity Unit

Optional element to define the net price basis quantity. All following ZUGFeRD properties are required to generate this element.

comfort

Unique Element

Element to define details on net price without taxes. To generate this element the ZUGFeRD property item.net-price-amount is required.

comfort

Unique Element

item.billed-quantity

Element to define the quantity. All following ZUGFeRD properties are required to generate this element.

Property Name	Description	Required	Profile	Type
item.billed-quantity	Position quantity.	yes	basic	Number
item.billed-quantity-unit	Position quantity unit.	yes	basic	Quantity Unit

Element to define the quantity. All following ZUGFeRD properties are required to generate this element.

basic

Unique Element

item.tax

Nested repeating element to define the taxes for this position. The ZUGFeRD property item.tax.percent is required to generate this element.

Property Name	Description	Required	Profile	Type
item.tax.type	Tax type of this position.		comfort	Tax Type
item.tax.reason	Tax exemption reason.		comfort	Text
item.tax.category	Tax category of this position.		comfort	Tax Category
item.tax.percent	Applicable tax percentage for this position.	yes	comfort	Number

Nested repeating element to define the taxes for this position. The ZUGFeRD property item.tax.percent is required to generate this element.

comfort

Repeating Element

item.global-id

Optional element to define the global ID of the product of this position. All following ZUGFeRD properties are required to generate this element.

Property Name	Description	Required	Profile	Type
item.global-id	Global ID of this product.	yes	comfort	Text
item.global-id-type	Code of the organisation in which the ID is registered.	yes	comfort	Global ID

Optional element to define the global ID of the product of this position. All following ZUGFeRD properties are required to generate this element.

comfort

Unique Element

With this repeating element it is possible to define more information for this position. To generate this element, the ZUGFeRD property item.name is required.

basic

Repeating Element

Property Types

Text

The type Text describes a free text or text content which will not be validated.

Number

The type Number includes amounts and percentages. The decimal mark has to be specified via the optional inputFormat property to ensure that the ZUGFeRD XML is valid. Further information about the inputFormat property can be found in the API documentation.

Date

The Date type requires the current input format for the date string, defined by the inputFormat property, and the output format for the ZUGFeRD document, defined by the scheme property. Further information about these properties can be found in the API documentation. Possible values for the output format are:

102	Year, Month and Day: yyyyMMdd
610	Year and Month: yyyyMM
616	Year und week: yyyyww

Document Type

The Document Type specifies the type of the document through a code. Possible document types are:

84	Debit note related to financial adjustments
380	Commercial invoice
389	Self-billed invoice

Subject Code

The Subject Code type describes the content of a note for electronic validation. Possible codes are:

""	General free text
REG	Regulatory information
AAK	Price conditions
AAJ	Additional conditions of sale/purchase
PMT	Payment information

Country Code

The Country Code is a 2 character code for countries. Following are some examples from the ZUGFeRD specification:

DE	Germany
FR	France
IT	Italy
CN	China

See

ISO 3166-1 alpha-2

Global ID

The type Global ID specifies the organisation in which the id of the buyer, seller or product is registered. The code of the organisation has to be defined by the scheme property. Further information about this property can be found in die API documentation. Following are some examples from the ZUGFeRD specification:

0021	SWIFT (BIC)
0060	D-U-N-S Number
0088	GS1 Global Location Number (GLN)
0160	GS1 Global Trade Item Number (GTIN, EAN)
0177	OSCAR (Odette)

See

ISO 6523

Currency Code

A 3 characters long code, specifying the currency used throughout the entire document. Following are some examples from the ZUGFeRD specification:

EUR	Euro
USD	United States Dollar
GBP	Pound sterling
COP	Colombian Peso

See

ISO 4217 3A

Payment Code

The Payment Code describes the payment method for electronical inspection. ZUGFeRD defines the following payment methods:

1	Instrument not defined
3	Automated clearing house debit
10	In cash
20	Cheque
31	Debit transfer
42	Payment to bank account
48	Bank card
49	Direct debit
97	Clearing between partners

Tax Type

The type Tax indicates which tax type applies. ZUGFeRD defines the following tax types:

VAT	Value added tax
ZF_INSURANCE_TAX	Insurance tax (temporary)
AAJ	Tax on replacement part

Tax Category

The type Tax Category describes which tax category applies. ZUGFeRD defines the following tax categories:

AE	VAT Reverse Charge
E	Exempt from tax
Z	Zero rated goods
O	Services outside scope of tax
IC	Code specifying that the VAT rate is levied from the invoicee for Intra-Community supplies.
S	Valid for regular VAT-rates, e.g. 7 % or 19 % in Germany

Quantity Unit

The Quantity Unit describes the quantity unit as a ZUGFeRD code. Following are some examples from the ZUGFeRD specification:

C62	Piece
DAY	Day
HAR	Hectare
HUR	Hour
KGM	Kilogram
KTM	Kilometre
KWH	Kilowatt hour
LS	Lump sum
LTR	Litre
MIN	Minute
MMK	Square millimetre
MMT	Millimetre
MTK	Square meter
MTQ	Cubic meter
MTR	Meter
NAR	Article quantity
NPR	Pair quantity
P1	Percent
SET	Set
TNE	Metric ton
WEE	Week
BA	Barrel
BC	Bottlecrate, bottlerack
BG	Bag
BO	Bottle, non-protected, cylindrical
BX	Box
CS	Case
CT	Carton
CX	Can, cylindrical
NE	Unpacked or unpackaged
PX	Palett
RO	Roll
SA	Sack

See

UNCL 7065 (Version D.13A)

ZUGFeRD Properties

Property List

Property Types

Text

Number

Date

Document Type

Subject Code

Country Code

See

Global ID

See

Currency Code

See

Payment Code

Tax Type

Tax Category

Quantity Unit

See