ph-ubl

This is the readme file for version 5.x or later.

Set of Java libraries for reading and writing OASIS UBL 2.0, 2.1, 2.2, 2.3 and 2.4 documents. The following projects are contained:

• ph-ubl-testfiles contains all UBL test files (used only in Maven test scope)
• ph-ubl-api base library containing common stuff for UBL testing only.
• ph-ubl20 contains the generated JAXB files for UBL 2.0 as well as the helper classes.
• ph-ubl20-codelists contains the generated enums for the UBL 2.0 codelists (optional artefact)
• ph-ubl21 contains the generated JAXB files for UBL 2.1 as well as the helper classes.
• ph-ubl21-codelists contains the generated enums for the UBL 2.1 codelists (optional artefact)
• ph-ubl22 contains the generated JAXB files for UBL 2.2 as well as the helper classes.
• ph-ubl22-codelists contains the generated enums for the UBL 2.2 codelists (optional artefact)
• ph-ubl23 contains the generated JAXB files for UBL 2.3 as well as the helper classes.
• ph-ubl23-codelists contains the generated enums for the UBL 2.3 codelists (optional artefact)
• ph-ubl24 contains the generated JAXB files for UBL 2.4 as well as the helper classes.
• ph-ubl24-codelists contains the generated enums for the UBL 2.4 codelists (optional artefact)
• ph-ubltr contains the generated JAXB files UBL-tr - the Turkish e-Invoice (optional artefact)
• ph-ublpe contains the generated JAXB files for UBLPE #openinvoiceperu (optional artefact)
• ph-ubl-dian contains the generated JAXB files for the Colombian e-Invoice (optional artefact)
• ph-ubl-eforms contains the generated JAXB files for the EU eForms objects (optional artefact) - see https://ec.europa.eu/growth/single-market/public-procurement/digital-procurement/eforms_en

Building

This project requires Java 1.8 or higher to be build and used.

The JAXB generated sources are created dynamically via mvn process-sources and are not part of the committed source files. This is also automatically called when you call mvn clean install. The folders with the generated sources differ from subproject to subproject:

• ph-ubl20: target\generated-sources\ubl20
• ph-ubl21: target\generated-sources\ubl21
• ph-ubl22: target\generated-sources\ubl22
• ph-ubl23: target\generated-sources\ubl23
• ph-ubl24: target\generated-sources\ubl24
• ph-ublpe: target\generated-sources\ublpe
• ph-ubltr: target\generated-sources\ubltr
• ph-ubl-dian: target\generated-sources\dian
• ph-ubl-eforms: target\generated-sources\eforms

Examples

An example for reading and writing UBL 2.0 files can be found in the test file UBL20FuncTest.java. An example to create an invoice from scratch can be found in the test code CreateInvoiceFromScratchFuncTest.java.

An example for reading and writing UBL 2.1 files can be found in the test file UBL21FuncTest.java. An example to create an invoice from scratch can be found in the test code CreateInvoiceFromScratchFuncTest.java.

Maven usage generic

You can use ph-ubl as a BOM (bill of material) when you include the following in the dependencyManagement section of your POM, replacing x.y.z with the effective version number:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl-parent-pom</artifactId>
  <version>x.y.z</version>
  <type>pom</type>
  <scope>import</scope>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL 2.0

To read and write UBL 2.0 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl20</artifactId>
  <version>x.y.z</version>
</dependency>

To also use the generated enums for the UBL 2.0 codelists add the following artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl20-codelists</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL 2.1

To read and write UBL 2.1 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl21</artifactId>
  <version>x.y.z</version>
</dependency>

To also use the generated enums for the UBL 2.1 codelists add the following artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl21-codelists</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL 2.2

To read and write UBL 2.2 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl22</artifactId>
  <version>x.y.z</version>
</dependency>

To also use the generated enums for the UBL 2.2 codelists add the following artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl22-codelists</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL 2.3

To read and write UBL 2.3 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl23</artifactId>
  <version>x.y.z</version>
</dependency>

To also use the generated enums for the UBL 2.3 codelists add the following artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl23-codelists</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL 2.4

To read and write UBL 2.4 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl24</artifactId>
  <version>x.y.z</version>
</dependency>

To also use the generated enums for the UBL 2.4 codelists add the following artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl24-codelists</artifactId>
  <version>x.y.z</version>
</dependency>

Supported since v8.0.0

Maven usage UBL-tr

To read and write UBL-tr (http://www.ubltr.com/) documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubltr</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage UBL-PE

To read and write UBL-PE 2.0 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ublpe</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage Dian UBL

To read and write Dian UBL 2.1 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl-dian</artifactId>
  <version>x.y.z</version>
</dependency>

Note: prior to v6.3.0 the Maven groupId was com.helger.

Maven usage eForms UBL

To read and write eForms UBL 2.3 documents add the following to your pom.xml to use this artifact:

<dependency>
  <groupId>com.helger.ubl</groupId>
  <artifactId>ph-ubl-eforms</artifactId>
  <version>x.y.z</version>
</dependency>

Supported since v6.7.0

Gradle considerations

Old versions of this project rely on JDK version based Maven profile activation. See https://github.com/phax/ph-jaxb-pom#gradle-usage for help on this specific issue.

Download

Binary versions of the artefacts can be downloaded from Maven Central:

• https://repo1.maven.org/maven2/com/helger/ph-ubl-testfiles/
• https://repo1.maven.org/maven2/com/helger/ph-ubl-api/
• https://repo1.maven.org/maven2/com/helger/ph-ubl20/
• https://repo1.maven.org/maven2/com/helger/ph-ubl20-codelists/
• https://repo1.maven.org/maven2/com/helger/ph-ubl21/
• https://repo1.maven.org/maven2/com/helger/ph-ubl21-codelists/
• https://repo1.maven.org/maven2/com/helger/ph-ubl22/
• https://repo1.maven.org/maven2/com/helger/ph-ubl22-codelists/
• https://repo1.maven.org/maven2/com/helger/ph-ubl23/
• https://repo1.maven.org/maven2/com/helger/ph-ubl23-codelists/
• https://repo1.maven.org/maven2/com/helger/ph-ubl24/
• https://repo1.maven.org/maven2/com/helger/ph-ubl24-codelists/
• https://repo1.maven.org/maven2/com/helger/ph-ublpe/
• https://repo1.maven.org/maven2/com/helger/ph-ubltr/
• https://repo1.maven.org/maven2/com/helger/ph-ubl-dian/
• https://repo1.maven.org/maven2/com/helger/ph-ubl-eforms/

Other UBL sites

For further information on the Universal Business Language can be found on the following pages:

• https://www.oasis-open.org/committees/ubl/
  • UBL 2.0: https://docs.oasis-open.org/ubl/os-UBL-2.0/
  • UBL 2.1: https://docs.oasis-open.org/ubl/os-UBL-2.1/
  • UBL 2.2: https://docs.oasis-open.org/ubl/os-UBL-2.2/
  • UBL 2.3: https://docs.oasis-open.org/ubl/os-UBL-2.3/
  • UBL 2.4: https://docs.oasis-open.org/ubl/os-UBL-2.4/
• http://ubl.xml.org
• http://goubl.com
• http://www.ubltr.com/

News and noteworthy

• v9.0.3 - 2024-09-17
  • Extended the API in EUBL2*DocumentType to retrieve the root namespace URL and local element name. See #65 - thx @GediminasVaistai
• v9.0.2 - 2024-07-31
  • Updated to UBL 2.4 final (no XSD changes compared to CS01)
  • Updated to eForms SDK 1.12.0
  • Extended all UBL..Marshaller classes with a getAllBaseXSDs () API
• v9.0.1 - 2024-03-28
  • Updated to ph-commons 11.1.5
  • Ensured Java 21 compatibility
• v9.0.0 - 2024-03-04
  • Updated to UBL 2.4-CS01
  • Updated to eForms SDK 1.10.1
  • Switched JAXB Maven plugin to org.jvnet.jaxb:jaxb-maven-plugin
  • Removed deprecated classes and elements
  • Added new enum EUBL24DocumentType
• v8.0.3 - 2023-07-31
  • Updated to ph-commons 11.1
• v8.0.2 - 2023-04-30
  • Extended the UBL2(0|1|2|3|4)Marshaller classes with additional APIs to access the XSDs
• v8.0.1 - 2023-04-28
  • Avoided the same name for the JAXB generated package for the unqualified datatypes in UBL 2.3 and 2.4
• v8.0.0 - 2023-04-21
  • Added support for UBL 2.4-CSD01 - new submodules ph-ubl24 and ph-ubl24-codelists
  • Updated to ph-commons 11.0.3
  • New classes UBL2(0|1|2|3|4)Marshaller that can read, write and validate
  • Deprecated classes EUBL20DocumentType, UBL20DocumentType, UBL20(Reader|Validator|Writer) and UBL20(Reader|Validator|Writer)Builder
  • Moved the XML Schemas to a new path that starts with external/
  • By updating to ph-jaxb-plugin v4.0.2 an integrity error could be resolved
• v7.0.0 - 2023-01-09
  • Using Java 11 as the baseline
  • Updated to ph-commons 11
  • Using JAXB 4.0 as the baseline
• v6.7.0 - 2021-12-29
  • Added support for "eForms" from https://github.com/OP-TED/eForms-SDK - see see #42 - Thx to @jonatanprins and @DKamerbeek
• v6.6.3 - 2021-09-21
  • Updated to the final UBL 2.3 XML Schemas - no changes compared to CS01 except for comments
  • Updated dependencies, so that the date/time objects now implement Serializable and that date/time objects are allowed to have no second fractions. The same effect can be reached by explicitly using v6.6.2 with ph-commons 10.1.3
• v6.6.2 - 2021-05-16
  • Removed all the default UBL XSDs for Xades, XMLDsig and CCTS to avoid confusion with the generic ones from the ph-xsds-* artefacts. This might be an incompatible change, if you reference the files in a JAXB ctaalog file.
• v6.6.1 - 2021-05-13
  • Improved the handling for the Dian Extension and ensuring the "sts" namespace prefix is used.
• v6.6.0 - 2021-05-02
  • Updated to ph-commons 10.1.0
  • Changed the JAXB binding for date time types XMLOffset(Date|Time|DateTime) - last change - sorry
• v6.5.0 - 2021-03-21
  • Updated to ph-commons 10.0.0
  • Changed the JAXB binding for date time types Offset(Date|Time|DateTime)
• v6.4.3 - 2021-02-11
  • Updated to UBL 2.3 CS01 - https://docs.oasis-open.org/ubl/cs01-UBL-2.3/UBL-2.3.html
• v6.4.2 - 2020-12-18
  • Updated to UBL 2.3 CSD04 - https://docs.oasis-open.org/ubl/csd04-UBL-2.3/UBL-2.3.html
• v6.4.1 - 2020-09-17
  • Updated to Jakarta JAXB 2.3.3
• v6.4.0 - 2020-08-30
  • Binds to ph-commons 9.4.7
  • Updated to UBL 2.3 CSD03 - https://docs.oasis-open.org/ubl/csd03-UBL-2.3/UBL-2.3.html
  • Added constants on metadata of the codelists (see #29)
  • Changed the XML adapters for date and time values to use LocalDate, LocalTime and LocalDateTime - see #27
• v6.3.0 - 2020-05-26
  • Changed Maven groupId to com.helger.ubl
• v6.2.1 - 2020-02-06
  • Added predefined constants for shared XSDs in the CUBL.. classes
  • Fixed a classloader issue in ph-ublpe in OSGI environments
  • Started new subproject ph-ubl-dian for the Colombian eInvoice
    • Based on https://www.dian.gov.co/fizcalizacioncontrol/herramienconsulta/FacturaElectronica/Documents/Caja_de_herramientas_Factura_Electronica_Validacion_Previa.zip
  • Updated to UBL 2.3 CSPRD02
• v6.2.0 - 2019-11-05
  • Added support for UBL 2.3 CSPRD01
• v6.1.3 - 2019-10-17
  • Added classes UBL20InvoiceHelper, UBL20CreditNoteHelper, UBL21InvoiceHelper, UBL21CreditNoteHelper, UBL22InvoiceHelper and UBL22CreditNoteHelper to allow for easy "type conversion"
• v6.1.2 - 2019-05-07
  • Added Java 12 support
• v6.1.1 - 2019-01-26
  • The ph-ubl-jaxb-plugin was moved to ph-jaxb22-plugin and is discontinued in here
• v6.1.0 - 2018-11-22
  • Requires at least ph-commons 9.2.0
• v6.0.2 - 2018-07-17
  • Added ph-ublpe suppport
  • Updated to UBL 2.2 final (from http://docs.oasis-open.org/ubl/os-UBL-2.2/UBL-2.2.zip)
• v6.0.1 - 2018-04-03
  • Updated to UBL 2.2 CS 01
• v6.0.0 - 2018-01-09
  • Binds to ph-commons 9.0.0
  • Added initial UBL 2.2 CSPRD02 support
  • Fixes issues #11
• v5.1.0 - 2016-09-09
  • Binds to ph-commons 8.5.x
• v5.0.3 - 2016-07-26
• v5.0.1 - 2016-07-22
• v5.0.0 - 2016-06-11
  • Binds to ph-commons 8.x
• v4.5.0 - 2015-11-30
  • New API that this more flexible and contains less overloads - see the examples
  • Added the possibility to easily customize the namespace prefix mapping and other things
• v4.0.0 - 2015-07-28
  • Restructured artefacts to use an "include on demand" instead of an "exclude on demand" pattern
  • Improved OSGI support

---

My personal Coding Styleguide | It is appreciated if you star the GitHub project if you like it.