Duplicate InvoiceReferencedDocument elements in corrected XRechnung (TypeCode 384) with invoice.setCorrection()

[thomasweitzel]

When generating XML files with the Mustangproject v2.16.2 and using setCorrection on the invoice, I get an invalid XML.

A Java fragment:

Invoice invoice = new Invoice();
/*using some setters except `setCorrection` */
invoice.setCorrection("test-123");

Excerpt from the generated XML file (the element InvoiceReferencedDocument appears twice with the same contents):

<ram:InvoiceReferencedDocument>
    <ram:IssuerAssignedID>test-123</ram:IssuerAssignedID>
</ram:InvoiceReferencedDocument>
<ram:InvoiceReferencedDocument>
    <ram:IssuerAssignedID>test-123</ram:IssuerAssignedID>
</ram:InvoiceReferencedDocument>

The XML is generated like this:

ZUGFeRD2PullProvider zf2p = new ZUGFeRD2PullProvider();
zf2p.setProfile(Profiles.getByName("XRechnung", 3));
zf2p.generateXML(invoice);
String theXML = new String(zf2p.getXML());

I'm using Java-22, but the problem is present with Java-21 (LTS), too.

[thomasweitzel]

Upon further investigation: the problem was caused by commit 5d741586 (2024-12-24 14:29 by cs), that added a line to Invoice.setCorrection: addInvoiceReferencedDocument ...

public Invoice setCorrection(String number) {
    setInvoiceReferencedDocumentID(number);
    addInvoiceReferencedDocument(new ReferencedDocument(number)); // <--
    documentCode = DocumentCodeTypeConstants.CORRECTEDINVOICE;
    return this;
}

When I remove this line, the XML is valid again.

There was much more added with this change, which probably had a good reason, but that I don't understand ;-)

@christoph-sommer

[jstaerk]

I had a look but I dont see it but that means you can easily send me a PR?

[thomasweitzel]

I don't want to send you a PR for my fix, because it just fixes the problem for me, but probably removes functionality used elsewhere and thus potentially negatively impacts the experience for others.

Here is a complete project with fictional data that runs with MustangProject 2.16.3 (which has the same problem) and shows what I reported as a bug.

The pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.synformation</groupId>
    <artifactId>xrechnung</artifactId>
    <version>0.1.0</version>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
            <version>2.18.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.18.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.18.2</version>
        </dependency>
        <dependency>
            <groupId>org.mustangproject</groupId>
            <artifactId>library</artifactId>
            <version>2.16.3</version>
        </dependency>
    </dependencies>

</project>

The class holding the fictional data InvoiceGenerator.java:

package com.synformation.xrechnung;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.List;

@JsonInclude(JsonInclude.Include.NON_NULL)
record InvoiceObject(
        String invoiceNumber,
        String buyerRefNo,
        String correctionRefNo,
        String generalNote,
        String invoiceDate,
        String deliveryDate,
        String dueDate,
        String deliveryPeriodFrom,
        String deliveryPeriodTo,
        String currency,
        String leitwegId,
        Party seller,
        Party buyer,
        List<Item> items
) {
}

@JsonInclude(JsonInclude.Include.NON_NULL)
record Party(
        String name,
        String street,
        String postalCode,
        String city,
        String country,
        String email,
        String vatId,
        String taxId,
        String taxOffice,
        Contact contact,
        Bank bank
) {
}

@JsonInclude(JsonInclude.Include.NON_NULL)
record Contact(
        String name,
        String phone,
        String email
) {
}

@JsonInclude(JsonInclude.Include.NON_NULL)
record Bank(
        String accountHolder,
        String iban,
        String bic
) {
}

@JsonInclude(JsonInclude.Include.NON_NULL)
record Item(
        String name,
        String description,
        String unit,
        double vatRate,
        double quantity,
        double price
) {
}

class InvoiceGenerator {
    public static InvoiceObject generateInvoice() throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();

        String json = """
                {
                    "invoiceNumber": "ABC012025-1",
                    "buyerRefNo": "Rahmenvertrag ABC-CUST von 23.12.2023",
                    "correctionRefNo": "ABC012025",
                    "generalNote": "Diese Rechnung ist eine Korrektur und ersetzt Rechnung Nr. ABC012025.",
                    "invoiceDate": "2025-01-31",
                    "deliveryDate": "2025-01-31",
                    "dueDate": "2025-02-28",
                    "deliveryPeriodFrom": "2025-01-01",
                    "deliveryPeriodTo": "2025-01-31",
                    "currency": "EUR",
                    "leitwegId": "N/A",
                    "seller": {
                        "name": "Boris König",
                        "street": "Konrad-Adenauer-Str. 50",
                        "postalCode": "63225",
                        "city": "Langen (Hessen)",
                        "country": "DE",
                        "email": "bkoenig@example.org",
                        "vatId": "DE364960222",
                        "taxId": "02082388189",
                        "taxOffice": "Finanzamt Langen",
                        "contact": {
                            "name": "Boris König",
                            "phone": "+4912312345678",
                            "email": "bkoenig@example.org"
                        },
                        "bank": {
                            "accountHolder": "Boris König",
                            "iban": "DE90500105172941767821",
                            "bic": "INGDDEFFXXX"
                        }
                    },
                    "buyer": {
                        "name": "Transformations GmbH",
                        "street": "Theodor-Heuss-Str. 44",
                        "postalCode": "70176",
                        "city": "Stuttgart",
                        "country": "DE",
                        "email": "buchhaltung@example.com"
                    },
                    "items": [
                        {
                            "name": "Projekt Production Finance",
                            "description": "Anzahl Stunden für Beratung",
                            "unit": "HUR",
                            "vatRate": 19,
                            "quantity": 152.5,
                            "price": 125.00
                        },
                        {
                            "name": "Reiseaufwand-Pauschale",
                            "description": "Vereinbarter Betrag für An- und Abreisezeiten",
                            "unit": "C62",
                            "vatRate": 19,
                            "quantity": 1,
                            "price": 200.00
                        },
                        {
                            "name": "Hotelkosten (Netto)",
                            "description": "Weiterberechnung als Leistung gemäß §3 Abs. 1b UStG",
                            "unit": "MON",
                            "vatRate": 19,
                            "quantity": 1,
                            "price": 259.00
                        }
                    ]
                }
                """;

        return objectMapper.readValue(json, InvoiceObject.class);
    }
}

The class generating the XML for the CII invoice:

package com.synformation.xrechnung;

import org.mustangproject.*;
import org.mustangproject.ZUGFeRD.Profiles;
import org.mustangproject.ZUGFeRD.ZUGFeRD2PullProvider;

import java.math.BigDecimal;
import java.sql.Date;

public class XRechnungGenerator {

    public static void main(String[] args) throws Exception {

        InvoiceObject data = InvoiceGenerator.generateInvoice();

        // Create the XML file
        TradeParty seller = createTradeParty(data.seller());
        TradeParty buyer = createTradeParty(data.buyer());

        Invoice invoice = new Invoice()
                .setDueDate(Date.valueOf(data.dueDate()))
                .setIssueDate(Date.valueOf(data.invoiceDate()))
                .setDeliveryDate(Date.valueOf(data.deliveryDate()))
                .setSender(seller)
                .setRecipient(buyer)
                .setNumber(data.invoiceNumber())
                .setCurrency(data.currency());
        // Optional parts
        String buyerRefNo = data.buyerRefNo();
        if (null != buyerRefNo) { // Check if buyerRefNo exists
            invoice.setBuyerOrderReferencedDocumentID(buyerRefNo);
        }
        String leitwegId = data.leitwegId();
        if (null != leitwegId) { // Check if leitwegId exists
            invoice.setReferenceNumber(leitwegId);
        }
        String deliveryPeriodFrom = data.deliveryPeriodFrom();
        if (null != deliveryPeriodFrom) { // Check if deliveryPeriodFrom exists
            invoice.setDetailedDeliveryPeriodFrom(Date.valueOf(deliveryPeriodFrom));
        }
        String deliveryPeriodTo = data.deliveryPeriodTo();
        if (null != deliveryPeriodTo) { // Check if deliveryPeriodTo exists
            invoice.setDetailedDeliveryPeriodTo(Date.valueOf(deliveryPeriodTo));
        }
        String correctionRefNo = data.correctionRefNo();
        if (null != correctionRefNo) {
            invoice.setCorrection(correctionRefNo);
        }
        // General note
        String generalNote = data.generalNote();
        if (null != generalNote) {
            invoice.addGeneralNote(generalNote.trim());
        }

        // Add items
        for (Item item : data.items()) {
            invoice.addItem(createItem(item));
        }

        generateCIIInvoice(invoice);
    }

    private static TradeParty createTradeParty(Party partyData) {
        TradeParty party = new TradeParty(
                partyData.name(),
                partyData.street(),
                partyData.postalCode(),
                partyData.city(),
                partyData.country())
                .setEmail(partyData.email());
        // Optional parts
        String vatId = partyData.vatId();
        if (null != vatId) { // Check if vatId exists
            party.setVATID(vatId);
        }
        String taxId = partyData.taxId();
        if (null != taxId) { // Check if taxId exists
            party.setTaxID(taxId);
        }
        Bank bankData = partyData.bank();
        if (null != bankData) { // Check if bank data exists
            BankDetails bankDetails = new BankDetails(
                    bankData.iban(),
                    bankData.bic())
                    .setAccountName(bankData.accountHolder());
            party.addBankDetails(bankDetails);
        }
        Contact contactData = partyData.contact();
        if (null != contactData) { // Check if contact data exists
            org.mustangproject.Contact contact = new org.mustangproject.Contact(
                    contactData.name(),
                    contactData.phone(),
                    contactData.email());
            party.setContact(contact);
        }

        return party;
    }

    private static org.mustangproject.Item createItem(Item itemData) {
        BigDecimal quantity = BigDecimal.valueOf(itemData.quantity());
        BigDecimal vatRate = BigDecimal.valueOf(itemData.vatRate());
        BigDecimal price = BigDecimal.valueOf(itemData.price());
        String unit = itemData.unit() != null ? itemData.unit() : "C62"; // Unit is the default unit

        Product product = new Product(
                itemData.name(),
                itemData.description(),
                unit,
                vatRate);
        return new org.mustangproject.Item(product, price, quantity);
    }

    private static void generateCIIInvoice(Invoice invoice) {
        ZUGFeRD2PullProvider zf2p = new ZUGFeRD2PullProvider();
        zf2p.setProfile(Profiles.getByName(EStandard.cii, "XRECHNUNG", 3));
        zf2p.generateXML(invoice);
        String theXML = new String(zf2p.getXML());
        System.out.println(theXML);
    }

}

I used MustangProject 2.16.3 together with Java 21 LTS.

Near the end of the XML output, you can see a repeated XML element:

<ram:InvoiceReferencedDocument>
    <ram:IssuerAssignedID>ABC012025</ram:IssuerAssignedID>
</ram:InvoiceReferencedDocument>
<ram:InvoiceReferencedDocument>
    <ram:IssuerAssignedID>ABC012025</ram:IssuerAssignedID>
</ram:InvoiceReferencedDocument>

[christoph-sommer]

I have already found the bug myself and fixed it in PR #728

[christoph-sommer]

PR #728 has been merged and closed. The problem should be fixed.

[thomasweitzel]

The problem was indeed fixed with commit #728 which went live with 2.16.4.