dmt-software/ubl-service

Service to handle UBL documents

0.1.1 2025-10-28 11:34 UTC

Requires

• php: >=8.3
• ext-simplexml: *
• jms/serializer: ^3.32

Requires (Dev)

• phpunit/phpunit: ^12.0

MIT

• Bas de Mes

README

Service to create and process UBL xml documents.

Install

composer require dmt-software/ubl-service

Usage

Invoice XML

Create an UBL Invoice XML

use DMT\Ubl\Service\Entity\Invoice;
use DMT\Ubl\Service\InvoiceService;

/** @var Invoice $invoice */
$service = new InvoiceService();
print $service->toXml($invoice);

// <Invoice xmlns:cac="...">...</Invoice>

Process an UBL Invoice XML

use DMT\Ubl\Service\InvoiceService;

$service = new InvoiceService();
$invoice = $service->fromXml('<Invoice xmlns:cac="...">...</Invoice>');

// process the invoice

Transformers

Create UBL Invoice from DTO

use DMT\Ubl\Service\InvoiceService;
use DMT\Ubl\Service\Transformer\Invoice\SimpleObjectToInvoiceTransformer;
use DMT\Ubl\Service\Objects\Invoice;

/** @var Invoice $invoice */
$service = new InvoiceService();
$ublInvoice = $service->toInvoice($invoice, new SimpleObjectToInvoiceTransformer());

Fetch DTO from UBL Invoice

use DMT\Ubl\Service\InvoiceService;
use DMT\Ubl\Service\Transformer\Invoice\InvoiceLineToSimpleObjectTransformer;
use DMT\Ubl\Service\Entity\Invoice;

/** @var Invoice $ublInvoice */
$service = new InvoiceService();
$invoice = $service->fromInvoice($ublInvoice, new InvoiceLineToSimpleObjectTransformer());

Validation

use DMT\Ubl\Service\InvoiceService;
use InvalidArgumentException;

$service = new InvoiceService();
try {
    // test (and formats) the identifier
    $identifier = $service->checkIdentifier('0000000000123', 'GTIN');
} catch (InvalidArgumentException) {
    // identifier is invalid
}

Different UBL versions

By default toXml will return an UBL Invoice in PEPPOL BIS Billing 3.0 format.
To change the format you can add the correct format in the call:

use DMT\Ubl\Service\Entity\Invoice;
use DMT\Ubl\Service\InvoiceService;

/** @var Invoice $invoice */
$service = new InvoiceService();
print $service->toXml($invoice, Invoice::VERSION_NLCIUS);

// output is according to the NLCIUS format

It is possible to change format from an existing XML by creating an invoice using fromXML followed by toXML with a different format.

NOTE: When changing format, especially from new to older one, some data may be lost or invalid.