stann / factur-x
Installs: 81
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/stann/factur-x
Requires
- php: ^8.1
- ext-dom: *
- ext-libxml: *
- ext-simplexml: *
- mpdf/mpdf: ^8.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.92
- phpstan/phpstan: ^2.1
- phpunit/phpunit: ^10.0
This package is auto-updated.
Last update: 2025-12-23 22:19:49 UTC
README
A modern PHP 8.1+ library for creating Factur-X electronic invoices, compatible with Chorus Pro. Uses mPDF to generate PDF/A-3 documents.
- Create a Factur-X document
- Validate against official XSD schemas
- Read a Factur-X document (coming soon)
Installation
composer require stann/factur-x
Usage
Create a Factur-X document
Using the builder (recommended):
<?php use Stann\FacturX\AppendixParts\ExchangedDocument; use Stann\FacturX\AppendixParts\MonetarySummation; use Stann\FacturX\AppendixParts\TradeParty; use Stann\FacturX\AppendixParts\TypeCode; use Stann\FacturX\CrossIndustryInvoiceBuilder; use Stann\FacturX\FacturX; use Stann\FacturX\ValueObjects\CountryCode; use Stann\FacturX\ValueObjects\VATNumber; $invoice = CrossIndustryInvoiceBuilder::minimum() ->withDocument(new ExchangedDocument('F0003', TypeCode::INVOICE, new DateTimeImmutable())) ->withSeller(new TradeParty('Stann', '34261828837536', CountryCode::FRANCE, new VATNumber('FR520000000'))) ->withBuyer(new TradeParty('Mairie de Toulouse', '10881392400937', CountryCode::FRANCE, new VATNumber('FR980000000'))) ->withAmounts(new MonetarySummation('EUR', 100.00, 120.00, 120.00)) ->withBuyerReference('1004') // Optional, for Chorus Pro "Service Exécutant" ->withBuyerOrderReference('BDC001') // Optional, for Chorus Pro "Engagement Juridique" ->build(); $facturX = (new FacturX())->createFile( fopen(__DIR__ . '/assets/facture.pdf', 'rb'), $invoice, );
Or using the constructor directly:
$invoice = new CrossIndustryInvoice( document: new ExchangedDocument('F0003', TypeCode::INVOICE, new DateTimeImmutable()), sellerTradeParty: new TradeParty('Stann', '34261828837536', CountryCode::FRANCE, new VATNumber('FR520000000')), buyerTradeParty: new TradeParty('Mairie de Toulouse', '10881392400937', CountryCode::FRANCE, new VATNumber('FR980000000')), monetarySummation: new MonetarySummation('EUR', 100.00, 120.00, 120.00), buyerReference: '1004', buyerOrderReference: 'BDC001', );
Available profiles
The builder provides factory methods for each Factur-X profile:
CrossIndustryInvoiceBuilder::minimum(); // Simplest profile CrossIndustryInvoiceBuilder::basicWL(); // Basic Without Lines CrossIndustryInvoiceBuilder::basic(); // With invoice lines CrossIndustryInvoiceBuilder::en16931(); // European standard CrossIndustryInvoiceBuilder::extended(); // Full features
Note:
withBuyerContractReference()is only available for BASIC_WL and higher profiles.
Validation
Validate your document against official XSD schemas:
<?php use Stann\FacturX\FacturX; use Stann\FacturX\Schema; $facturX = new FacturX(); // Throws InvalidXMLSchema with LibXMLError[] on failure $facturX->validate($invoice->toXml(), Schema::MINIMUM); // Returns boolean $facturX->isValid($invoice->toXml(), Schema::MINIMUM); // Returns LibXMLError[] $errors = $facturX->getValidationErrors($invoice->toXml(), Schema::MINIMUM);
Available schemas
Schema::MINIMUMSchema::BASIC_WLSchema::BASICSchema::EN16931Schema::EXTENDED