README

A modern object-oriented PHP library to create and read valid UBL and Peppol BIS 3.0 files. Please feel free to contribute if you are missing features or tags.

Installation and usage

This package is fully compatible with PHP 8.x and also supports PHP 7.4. You can install it using Composer.

$ composer require num-num/ubl-invoice

Creating UBL files

$invoice = (new \NumNum\UBL\Invoice())
    ->setUBLVersionId('2.4')
    ->setId(123);
    // ... etc, all other props you need

$generator = new \NumNum\UBL\Generator();
$ublXml = $generator->invoice($invoice);

Please check some of the example code in the tests/Write folder to see how you can quickly create an UBL file and use all included properties.

Reading UBL files ✨

Need to quickly read UBL files? As of version 2.0, this library now supports UBL file reading. It's simple and easy to use:

$ublReader = \NumNum\UBL\Reader::ubl();
$invoice = $ublReader->parse(file_get_contents($fileName));
var_dump($invoice); // An \NumNum\UBL\Invoice instance with filled properties!

Please check some additional example code in the tests/Read folder.

Upgrading

If you are upgrading from version 1.x to 2.0, please check the UPGRADING.md guide for breaking changes and migration instructions.

Contributing - bug reporting

This library is not 100% UBL/Peppol feature-complete, in the sense that it doesn't (yet) support all UBL XML tags & functionality. "Yet" being the keyword, since this definitely is the long-term goal. However, all common UBL tags that are required to create and read most common invoices and creditnotes are present in the library. This includes tags for discounts, cash discounts, special vat rates, etc...

If you are missing functionality, please feel free to add it :-) Adding additional tags & attributes is very straight-forward. Check out CONTRIBUTING.md for more information.

Are you experiencing a bug? Please feel free to open an issue in the issue tracker!

Documentation

• Getting Started - Quick start guide with installation and basic examples
• Creating Invoices - Detailed invoice creation guide
• Creating Credit Notes - Credit note creation guide
• Reading UBL Files - Parsing existing UBL documents
• Advanced Features - Payment means, attachments, EN16931 compliance

For additional examples, check the unit tests in the tests folder.

Changelog

Since version 2.0, all changelog information can be found on the GitHub Releases page.