einvoice / EN 16931 / XRechnung rule reference

BR-CL-03

What this rule means and how to fix it

CurrencyID MUST be coded using ISO 4217 alpha-3.

Die Währungskennung (currencyID) MUSS anhand der ISO-Codeliste 4217 Alpha-3 codiert werden.

Deutsche Fassung: Übersetzung der gleichen BT/BG-Semantik (translation — not the official assert).

Requires
currencyID MUST be coded using ISO code list 4217 alpha-3
Business terms
— (no single business term)
Syntax
Binds the UBL-2.1 Invoice / CreditNote syntax and the UN/CEFACT-CII syntax
Location (UBL-2.1 path)
cbc:Amount
Fix
Encode `cbc:Amount` using a valid value from ISO code list 4217 alpha-3.
Fix (Deutsch)
Codieren Sie `cbc:Amount` mit einem gültigen Wert aus der geforderten Codeliste: Die Währungskennung (currencyID) MUSS anhand der ISO-Codeliste 4217 Alpha-3 codiert werden.
Severity
fatal
Provenance source
en16931-ubl
Provenance assert

currencyID MUST be coded using ISO code list 4217 alpha-3

The Location above is a UBL-2.1 path, and no UN/CEFACT-CII path for this rule is published here; Fix and Fix (Deutsch), verbatim from remediation_catalog.json and not reworded here; the UN/CEFACT-CII binding of this rule is differentially proven against the official CEN EN 16931 1.3.16 Schematron.

Where to check the fix: paste the corrected invoice into the browser validator at /einvoice/validate/ — it runs this same engine locally in your browser, with no upload, and stops reporting BR-CL-03 once the edit lands.

Korrektur prüfen: Laden Sie die geänderte Rechnung in den Browser-Validator unter /einvoice/validate/ — er führt dieselbe Engine lokal im Browser aus, ohne Upload, und meldet BR-CL-03 nicht mehr, sobald die Korrektur greift.

The same invoice, failing and fixed

No vendored test suite ships a labelled example for this rule, so this pair was found rather than written. The engine was run over the vendored instance corpus/xrechnung-testsuite/src/test/technical-cases/cius/01.06_minimal_test_ubl.xml under --profile xrechnung, then re-run over the same file with one mechanical edit applied to one element, over and over, until the edit below changed the verdict: the currencyID attribute of TaxAmount was changed from EUR to ZZZ, a token that appears in no code list. The page publishes it because the engine reported BR-CL-03 for the edited document and did not report it for the untouched one.

UBL Invoice — fails

The vendored file around the change, verbatim:

<cac:TaxTotal>
  <cbc:TaxAmount currencyID="ZZZ">757.41</cbc:TaxAmount>
  <cac:TaxSubtotal>
    <cbc:TaxableAmount currencyID="EUR">3986.34</cbc:TaxableAmount>
    <cbc:TaxAmount currencyID="EUR">757.41</cbc:TaxAmount>
    <cac:TaxCategory>
      <cbc:ID>S</cbc:ID>
      <cbc:Percent>19</cbc:Percent>
      <cac:TaxScheme>
        <cbc:ID>VAT</cbc:ID>
      </cac:TaxScheme>
    </cac:TaxCategory>
  </cac:TaxSubtotal>
</cac:TaxTotal>

UBL Invoice — passes

The same lines as 01.06_minimal_test_ubl.xml actually ships them — this block is the fix for the block above:

<cac:TaxTotal>
  <cbc:TaxAmount currencyID="EUR">757.41</cbc:TaxAmount>
  <cac:TaxSubtotal>
    <cbc:TaxableAmount currencyID="EUR">3986.34</cbc:TaxableAmount>
    <cbc:TaxAmount currencyID="EUR">757.41</cbc:TaxAmount>
    <cac:TaxCategory>
      <cbc:ID>S</cbc:ID>
      <cbc:Percent>19</cbc:Percent>
      <cac:TaxScheme>
        <cbc:ID>VAT</cbc:ID>
      </cac:TaxScheme>
    </cac:TaxCategory>
  </cac:TaxSubtotal>
</cac:TaxTotal>

What the engine reports for the edited invoice

{
  "element": "@currencyID",
  "field": "@currencyID",
  "fix_hint": "Encode `cbc:Amount` using a valid value from ISO code list 4217 alpha-3.",
  "location": "cbc:Amount",
  "message": "currencyID MUST be coded using ISO 4217 alpha-3; 'ZZZ' is not a listed currency code.",
  "rule": "BR-CL-03",
  "severity": "fatal",
  "terms": [],
  "title": "CurrencyID MUST be coded using ISO 4217 alpha-3."
}

Rule ids the engine reports for 01.06_minimal_test_ubl.xml untouched: BR-DE-TMP-32. After the edit, BR-CL-03 BR-CO-15 are reported that were not before — one mechanical edit can break more than one rule at a time, and BR-CO-15 is the neighbour this one takes with it.

Two honest limits. This is an edit that provokes the rule, not the only one, and it is not a claim about how real exporters break it. And it is the reverse of the fix a reader needs: the passing block is the vendored file's own content, which is what a conformant invoice looks like here.

Reproduce it yourself: take corpus/xrechnung-testsuite/src/test/technical-cases/cius/01.06_minimal_test_ubl.xml from this repository, apply the one edit named above, and run einvoice validate 01.06_minimal_test_ubl.xml --profile xrechnung --format json, or paste the file into the browser validator, which runs this same engine locally with no upload.

Everything here is free and open source — pick up whatever helps, at your own pace: