This is a low-level python implementation of the ZUGFeRD XML format. ZUGFeRD is a German format for sending digital invoices. ZUGFeRD XML files are to be attached to a PDF file. This library can be used to generate or parse the contents of this XML file as well as attach it to a PDF. We do not support parsing PDF files (for now).
By low-level, we mean that this library tries to model the ZUGFeRD data model 1:1 without any further abstractions or simplifications. You can set and parse all parameters defined in ZUGFeRD 2.3. To see which parameters are defined, please refer to the official ZUGFeRD specification, there is no documentation for this library that reiterates it.
All output is validated against the official XSDs, but no validation of profile levels (basic, comfort, extended) is performed.
The profile level is detected automatically based on the XML data and added to the PDF metadata.
With the possibly upcoming legal obligation to use digital formats for all B2B invoices in Germany, interest in this library is increasing. We built this library to ble able to use it in the pretix-zugferd module and we are planning to keep maintaining the library. However, it is not our core business and turnaround time on issus or PR reviews might be longer than usual due to other priorities. We do not offer paid consulting services around this library.
Parsing:
fromdrafthorse.models.documentimportDocumentsamplexml=open("sample.xml", "rb").read()
doc=Document.parse(samplexml)
print(doc.trade.agreement.seller.name)Document.parse() taskes a boolean parameter strict which defaults to True. This means that the parser will raise an error if it encounters any unknown element. If you set it to False, the parser will not raise an error and parse whatever it can.
Generating:
fromdatetimeimportdate, datetime, timedelta, timezonefromdecimalimportDecimalfromdrafthorse.models.accountingimportApplicableTradeTaxfromdrafthorse.models.documentimportDocumentfromdrafthorse.models.noteimportIncludedNotefromdrafthorse.models.partyimportTaxRegistrationfromdrafthorse.models.paymentimportPaymentMeans, PaymentTermsfromdrafthorse.models.tradeimportAdvancePayment, IncludedTradeTaxfromdrafthorse.models.tradelinesimportLineItemfromdrafthorse.pdfimportattach_xml# Build data structuredoc=Document()
doc.context.guideline_parameter.id="urn:cen.eu:en16931:2017"doc.header.id="RE1337"doc.header.type_code="380"doc.header.issue_date_time=date.today()
doc.header.notes.add(IncludedNote(content="Test Note 1"))
doc.trade.agreement.buyer.name="Kunde GmbH"doc.trade.agreement.buyer.address.country_id="DE"doc.trade.settlement.currency_code="EUR"doc.trade.settlement.payment_means.add(PaymentMeans(type_code="ZZZ"))
doc.trade.agreement.seller.name="Lieferant GmbH"doc.trade.agreement.seller.address.country_id="DE"doc.trade.agreement.seller.address.country_subdivision="Bayern"doc.trade.agreement.seller.tax_registrations.add(
TaxRegistration(id=("VA", "DE000000000"))
)
advance=AdvancePayment(
received_date=datetime.now(timezone.utc), paid_amount=Decimal(42)
)
advance.included_trade_tax.add(
IncludedTradeTax(
calculated_amount=Decimal(0),
type_code="VAT",
category_code="E",
rate_applicable_percent=Decimal(0),
)
)
doc.trade.settlement.advance_payment.add(advance)
li=LineItem()
li.document.line_id="1"li.product.name="Rainbow"li.agreement.gross.amount=Decimal("1198.8")
li.agreement.gross.basis_quantity= (Decimal("1.0000"), "C62") # C62 == unitli.agreement.net.amount=Decimal("999")
li.agreement.net.basis_quantity= (Decimal("1.0000"), "C62") # C62 == unitli.delivery.billed_quantity= (Decimal("1.0000"), "C62") # C62 == unitli.settlement.trade_tax.type_code="VAT"li.settlement.trade_tax.category_code="S"li.settlement.trade_tax.rate_applicable_percent=Decimal("20.00")
li.settlement.monetary_summation.total_amount=Decimal("999.00")
doc.trade.items.add(li)
trade_tax=ApplicableTradeTax()
trade_tax.calculated_amount=Decimal("199.80")
trade_tax.basis_amount=Decimal("999.00")
trade_tax.type_code="VAT"trade_tax.category_code="S"trade_tax.rate_applicable_percent=Decimal("20.00")
doc.trade.settlement.trade_tax.add(trade_tax)
doc.trade.settlement.monetary_summation.line_total=Decimal("999.00")
doc.trade.settlement.monetary_summation.charge_total=Decimal("0.00")
doc.trade.settlement.monetary_summation.allowance_total=Decimal("0.00")
doc.trade.settlement.monetary_summation.tax_basis_total=Decimal("999.00")
doc.trade.settlement.monetary_summation.tax_total= (Decimal("199.80"), "EUR")
doc.trade.settlement.monetary_summation.grand_total=Decimal("1198.8")
doc.trade.settlement.monetary_summation.due_amount=Decimal("1198.8")
terms=PaymentTerms()
terms.due=datetime.now(timezone.utc) +timedelta(days=30)
doc.trade.settlement.terms.add(terms)
# Generate XML filexml=doc.serialize(schema="FACTUR-X_EXTENDED")Document.serialize() will validate the generated XML against the specified schema and raise an error if it is not valid. If you want to avoid validation, you can set the schema parameter to None.
To run the included tests:
pip install -r requirements_dev.txt
py.test testsTo automatically sort your Imports as required by CI:
pip install isort
isort -rc .To validate files using mustang:
git clone https://github.com/ZUGFeRD/mustangproject.git
cd mustangproject
git checkout core-2.9.0
./mvnw clean package
java -jar Mustang-CLI/target/Mustang-CLI-2.7.4-SNAPSHOT.jar --action validate --source invoice.pdfIf you discover a security issue, please contact us at security@pretix.eu and see our Responsible Disclosure Policy further information.
Maintainer: Raphael Michel <michel@rami.io>
License of the Python code: Apache License 2.0
The PDF handling (drafthorse/pdf.py) was originally based on the code of factur-x, Copyright 2016-2018, Alexis de Lattre <alexis.delattre@akretion.com>, released under a BSD license.
The packages includes schemas and samples of the ZUGFeRD specification (.xsd and .xml files) which are owned by the Forum für elektronische Rechnungen bei der AWV e.V („FeRD“) and are released under a proprietary license that allows bundling them together with other software for free.