daniel-jorg-schuppelius / php-erechnung-toolkit
PHP library for creating, parsing and validating electronic invoices (XRechnung, ZUGFeRD/Factur-X) according to EN 16931.
Package info
github.com/Daniel-Jorg-Schuppelius/php-erechnung-toolkit
Language:XSLT
pkg:composer/daniel-jorg-schuppelius/php-erechnung-toolkit
Requires
- php: >=8.1 <8.6
- ext-dom: *
- ext-libxml: *
- dschuppelius/php-common-toolkit: ^1.1
Requires (Dev)
- daniel-jorg-schuppelius/php-pdf-toolkit: ^0.8.0
- laravel/pint: ^1.27
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^11.3
Suggests
- daniel-jorg-schuppelius/php-pdf-toolkit: Required for ZUGFeRD/Factur-X PDF generation with embedded XML invoices
README
PHP library for creating, parsing and validating electronic invoices (XRechnung, ZUGFeRD/Factur-X) according to EN 16931.
Features
- XRechnung: German e-invoicing standard for public sector
- ZUGFeRD 2.x / Factur-X: Hybrid PDF/A-3 with embedded XML
- EN 16931: European e-invoicing standard
- XBestellung / Peppol BIS Order: UBL purchase orders (docs)
- Order-X: CII purchase orders + hybrid PDF/A-3 (order-side Factur-X)
- Despatch Advice: UBL delivery notes (Peppol BIS Despatch Advice)
- UBL 2.1: Universal Business Language
- UN/CEFACT CII D16B: Cross Industry Invoice
Installation
composer require dschuppelius/php-erechnung-toolkit
Requirements
- PHP >= 8.2
- ext-dom
- ext-libxml
- dschuppelius/php-common-toolkit ^1.0
Quick Start
Creating an Invoice
use ERechnungToolkit\Builders\ERechnungDocumentBuilder; use DateTimeImmutable; // Create a basic invoice $invoice = ERechnungDocumentBuilder::create('INV-2026-001') ->withIssueDate(new DateTimeImmutable()) ->withSeller('Muster GmbH', 'DE123456789') ->withSellerAddress('Musterstraße 1', '12345', 'Berlin') ->withBuyer('Kunde AG') ->withBuyerAddress('Kundenweg 2', '54321', 'München') ->addLine('Beratungsleistung', 10, 150.00) ->build(); // Generate UBL XML (XRechnung) $ublXml = $invoice->toUblXml(); // Generate CII XML (ZUGFeRD) $ciiXml = $invoice->toCiiXml();
Creating an XRechnung
$leitwegId = '04011000-12345-67'; $xrechnung = ERechnungDocumentBuilder::xrechnung('XR-2026-001', $leitwegId) ->withIssueDate(new DateTimeImmutable()) ->withSeller('Verkäufer GmbH', 'DE123456789') ->withSellerAddress('Verkäuferstraße 1', '10115', 'Berlin') ->withSellerEndpoint('seller@example.com', 'EM') ->withBuyer('Öffentliche Verwaltung') ->withBuyerAddress('Amtsweg 1', '80333', 'München') ->withBuyerLeitwegId($leitwegId) ->addLine('Dienstleistung', 1, 1000.00) ->build();
Parsing an Invoice
use ERechnungToolkit\Parsers\ERechnungParser; $parser = new ERechnungParser(); // Parse from XML string $document = $parser->parse($xmlContent); // Parse from file $document = $parser->parseFile('/path/to/invoice.xml'); // Access invoice data echo $document->getId(); echo $document->getSeller()->getName(); foreach ($document->getLines() as $line) { echo $line->getItemName() . ': ' . $line->getNetAmount(); }
Supported Profiles
| Profile | Description |
|---|---|
| MINIMUM | ZUGFeRD 2.x MINIMUM |
| BASIC_WL | ZUGFeRD 2.x BASIC WL |
| BASIC | ZUGFeRD 2.x BASIC |
| EN16931 | EN 16931 (COMFORT) |
| EXTENDED | ZUGFeRD 2.x EXTENDED |
| XRECHNUNG | XRechnung 3.0 |
| XRECHNUNG_EXTENSION | XRechnung 3.0 Extension |
Order Profiles (XBestellung / Peppol BIS Order)
| Profile | Description |
|---|---|
| PEPPOL_ORDER_ONLY | Peppol BIS Order only 3 (international) |
| XBESTELLUNG | XBestellung v1.0 (German CIUS) |
Creating an Order (XBestellung)
use ERechnungToolkit\Builders\OrderBuilder; use ERechnungToolkit\Enums\UnitCode; $order = OrderBuilder::xbestellung('ORD-2026-001') ->withBuyer('Stadt Musterstadt') // ordering party (sender) ->withBuyerAddress('Rathausplatz 1', '12345', 'Musterstadt') ->withBuyerEndpoint('04011000-12345-67', '0204') // Leitweg-ID ->withSeller('Lieferant GmbH', 'DE123456789') // supplier (recipient) ->withSellerAddress('Lieferweg 2', '54321', 'Lieferstadt') ->withSellerEndpoint('DE123456789', '9930') ->addLine('Bürostuhl', 5, 120.00, UnitCode::PIECE, 'ART-4711') ->build(); $xml = $order->toUblXml(); // Parsing back use ERechnungToolkit\Parsers\OrderParser; $parsed = (new OrderParser)->parse($xml);
The bundled KoSIT validator is scenario-driven and can validate orders once the official XBestellung validation artifacts are added to
data/kosit/scenarios.xml. See docs/XBestellung for details.
ZUGFeRD/Factur-X PDF Generation
Generate PDF/A-3 invoices with embedded XML for automated processing. Requires dschuppelius/php-pdf-toolkit:
composer require daniel-jorg-schuppelius/php-pdf-toolkit
use ERechnungToolkit\Builders\ERechnungDocumentBuilder; use ERechnungToolkit\Generators\ZugferdPdfGenerator; // Create invoice $invoice = ERechnungDocumentBuilder::zugferd('ZF-2026-001') ->withIssueDate(new DateTimeImmutable()) ->withSeller('Verkäufer GmbH', 'DE123456789') ->withSellerAddress('Musterstraße 1', '12345', 'Berlin') ->withSellerBankAccount('DE89370400440532013000', 'COBADEFFXXX') ->withBuyer('Käufer AG') ->withBuyerAddress('Kundenweg 2', '54321', 'München') ->addLine('Beratung', 10, 150.00) ->build(); // Generate ZUGFeRD PDF with embedded XML $pdfGenerator = new ZugferdPdfGenerator(); $pdfGenerator->generateToFile($invoice, '/path/to/invoice.pdf'); // Or get PDF as bytes $pdfBytes = $pdfGenerator->generate($invoice); // With custom HTML template $customHtml = '<html>...</html>'; $pdfBytes = $pdfGenerator->generate($invoice, $customHtml);
The generated PDF:
- Is PDF/A-3 compliant for long-term archiving
- Contains the embedded XML invoice (CII format)
- Can be processed automatically by accounting software
- Is visually readable as a normal PDF invoice
Validation
Two layers:
XSD schema (pure PHP, no Java) — UblSchemaValidator validates UBL documents
(Invoice, CreditNote, Order, DespatchAdvice) against the bundled official OASIS
UBL 2.1 schemas via libxml. Catches structure / data type / element-order errors.
use ERechnungToolkit\Validators\UblSchemaValidator; $errors = (new UblSchemaValidator)->validate($document->toUblXml()); // [] = valid
Business rules (EN16931 / XRechnung) — validate UBL/CII against XML Schema, the
EN16931 Schematron rules and the XRechnung CIUS using the official KoSIT validator.
Both the validator jar (tools/kosit/validator.jar) and its configuration
(scenarios + schemas, data/kosit/) ship with this package, so validation works
out of the box.
Because the Schematron rules are distributed as XSLT 2.0 (not executable by PHP's XSLT 1.0 engine), the validator runs as an external Java process.
Validation Requirements
- A Java runtime (
javaonPATH) — availability is checked through the Common-Toolkit executable configuration; the call runs viaJava::execute() - The KoSIT validator jar — configured as a
javaExecutablesentry inconfig/erechnung_executables.json(defaulttools/kosit/validator.jar). Pointpathat your own jar there, or override per call with an explicit path or theKOSIT_VALIDATOR_JARenv var
use ERechnungToolkit\Validators\KositValidator; $validator = new KositValidator(); // uses the bundled jar + Java from PATH if ($validator->isAvailable()) { $result = $validator->validate($ublXml); // or ->validateFile('/path/to/invoice.xml') if ($result->isValid()) { echo 'Konform: ' . $result->getScenarioName(); } else { foreach ($result->getErrors() as $error) { echo $error->getCode() . ': ' . $error->getText() . PHP_EOL; } } }
ValidationResult exposes the conformance verdict (isValid()), the
accept/reject recommendation (isAccepted()), all rule messages by severity
(getErrors(), getWarnings(), getMessages()) and the raw KoSIT report
(getRawReport()).
License
AGPL-3.0-or-later
Author
Daniel Jörg Schuppelius - schuppelius.org