E invoice profiles by embewee · Pull Request #8 · codebarista-de/gallop

embewee · 2026-08-17T14:55:03Z

No description provided.

csteuer · 2026-08-20T17:12:23Z

+/**
+ * Selects which {@code ExchangedDocumentContext} identifiers {@link XRechnungWriter} writes.
+ * <p>
+ * XRechnung, ZUGFeRD (Germany) and Factur-X (France) all use the same Cross Industry Invoice (CII)
+ * syntax and the same EN16931 semantic data model — they only differ in the guideline and
+ * business-process URNs declared in the document context. Everything else {@link XRechnungWriter}
+ * produces is identical across profiles.
+ * <p>
+ * Note that {@code ZUGFERD_EN16931} and {@code FACTURX_EN16931} only cover the EN16931 ("COMFORT")
+ * conformance level. Other conformance levels (e.g. ZUGFeRD/Factur-X BASIC, MINIMUM, EXTENDED) use
+ * different guideline URNs and are not covered by this profile.
+ * <p>
+ * Also note that ZUGFeRD and Factur-X are
+ * hybrid formats that combine a PDF/A-3 document with an embedded XML; {@link XRechnungWriter} only
+ * produces the XML part — embedding it into a PDF/A-3 document is the caller's responsibility.
+ */


I think it's sufficient to say that the profile determines which kind of e-invoice format is produced, as long as it's based on the CII syntax.

csteuer · 2026-08-20T17:31:12Z

I think we can get rid of this file.

Testing whether a constant has a certain value or if a deprecated method uses a specific parameter value for the method it has been replaced with is not worth it, in my opinion.
It's unlikely that the constants are changed accidentally. If they are changed, the change is on purpose.
Same for the deprecated functions.

The other tests do not cover anything that is not already covered by the golden file tests.

csteuer · 2026-08-20T17:38:39Z

 /**
 * Writes a XRechnung XML with the data of an {@linkplain Invoice} object
 * <p>
 * The mapping from the XRechnung specification ID (like BT-82) to the corresponding XML element can be found
 * in the <code>XRechnung-v3.0.2-Syntax-Binding-Extension-UBL.pdf</code> or in the XRechnung bundle at:
 * <code>xrechnung-3.0.2-xrechnung-visualization-2024-06-20/xsl/cii-xr.xsl</code>
 * <p>
 * The writer will always produce valid XML, but it does not guarantee that the generated XRechnung is valid
 * according to the schema and the business rules.
 * E.g. if required data is missing the writer will create an empty element or omit the corresponding xml structure completely.
 * The XRechnung will only be valid if the data in the invoice object is correct.
 */
 public class XRechnungWriter {


Now that it's also possible to write Factur-X and ZUGFeRD XMLs this class name and the description must be changed. E.g. EInvoiceXMLWriter or EInvoiceCIIXMLWriter

csteuer · 2026-08-20T17:40:36Z

+ *
+ * <p>Scenarios and profiles are registered once in {@link TestHelper}.</p>
+ */
+public class InvoiceScenarioXmlTest {


Should be called after the class that it tests

csteuer · 2026-08-20T17:41:55Z

+public class InvoiceScenarioXmlTest {
+
+    @ParameterizedTest(name = "{0} / {1}")
+    @MethodSource("de.codebarista.gallop.TestHelper#invoiceProfilesAndScenarios")


If InvoiceProfileTest is removed, I would inline that and the other things that have been extracted into the TestHelper class.

csteuer · 2026-08-20T17:45:00Z


-Gallop does not manipulate your data. It writes the exact values you provide into the XRechnung XML,
-with no calculations or transformations (aside from necessary XML escaping).
+Gallop does not manipulate your data. It writes the exact values you provide into the XRechnung XML, with no


Suggested change

Gallop does not manipulate your data. It writes the exact values you provide into the XRechnung XML, with no

Gallop does not manipulate your data. It writes the exact values you provide into the XML, with no

csteuer · 2026-08-20T17:47:52Z

+e-invoice, but will not notice or complain when the result does not meet all the rules specified in the XRechnung
+standard.


Suggested change

e-invoice, but will not notice or complain when the result does not meet all the rules specified in the XRechnung

standard.

e-invoice, but will not notice or complain when the result does not meet all the rules specified in the

choosen e-invoice format.

csteuer · 2026-08-20T17:49:21Z

+```
+
+XRechnung, ZUGFeRD and Factur-X all share the same Cross Industry Invoice (CII) syntax and the same EN16931 semantic
+data model, so the same `Invoice` object works for all three — only the document context identifiers differ, and Gallop


Suggested change

data model, so the same `Invoice` object works for all three — only the document context identifiers differ, and Gallop

data model, so the same `Invoice` object works for all three. Only the document context identifiers differ, and Gallop

csteuer · 2026-08-20T17:49:53Z

+
+Note that ZUGFeRD and Factur-X are hybrid formats combining a PDF/A-3 document with embedded XML; Gallop only produces
+the XML part, embedding it into a PDF/A-3 document is up to you. Also note that unit codes conventionally differ by
+format: XRechnung examples use `XPP` for "piece", while ZUGFeRD examples use `H87` (see `UnitCode.java`) — pick the unit


Suggested change

format: XRechnung examples use `XPP` for "piece", while ZUGFeRD examples use `H87` (see `UnitCode.java`) — pick the unit

format: XRechnung examples use `XPP` for "piece", while ZUGFeRD examples use `H87` (see `UnitCode.java`). Pick the unit

csteuer · 2026-08-20T17:50:24Z

 ### Changelog

+- 2.3.0: Add `Profile` parameter for ZUGFeRD/Factur-X (EN16931) support alongside XRechnung; deprecate
+  `generateXRechnungXML(Invoice)` and `XRechnungWriter(Invoice)` in favor of the explicit-profile


Suggested change

`generateXRechnungXML(Invoice)` and `XRechnungWriter(Invoice)` in favor of the explicit-profile

`generateXRechnungXML(Invoice)` and `XRechnungWriter(Invoice)` in favor of the explicit-profile methods

embewee added 7 commits July 27, 2026 20:41

add support for profiles, support FacturX

4e98410

fix tests

2518f30

rename to InvoiceProfile

d823058

add tests, cleanup

4df7502

work on tests

f71405b

work on tests

43ce862

re-add README

a34c6e9

embewee requested a review from csteuer August 17, 2026 14:55

csteuer requested changes Aug 20, 2026

View reviewed changes

Navigation Menu

Uh oh!

E invoice profiles - #8

E invoice profiles#8
embewee wants to merge 7 commits into
masterfrom
e-invoice-profiles

embewee commented Aug 17, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

csteuer Aug 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Gallop does not manipulate your data. It writes the exact values you provide into the XRechnung XML, with no
	Gallop does not manipulate your data. It writes the exact values you provide into the XML, with no

		e-invoice, but will not notice or complain when the result does not meet all the rules specified in the XRechnung
		standard.

	data model, so the same `Invoice` object works for all three — only the document context identifiers differ, and Gallop
	data model, so the same `Invoice` object works for all three. Only the document context identifiers differ, and Gallop

	format: XRechnung examples use `XPP` for "piece", while ZUGFeRD examples use `H87` (see `UnitCode.java`) — pick the unit
	format: XRechnung examples use `XPP` for "piece", while ZUGFeRD examples use `H87` (see `UnitCode.java`). Pick the unit

	`generateXRechnungXML(Invoice)` and `XRechnungWriter(Invoice)` in favor of the explicit-profile
	`generateXRechnungXML(Invoice)` and `XRechnungWriter(Invoice)` in favor of the explicit-profile methods

Uh oh!

Conversation

embewee commented Aug 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants