en16931 0.1.0

The EN 16931 semantic data model and its business rules, as Rust types. Validates the model rather than a serialised document, so findings point at BT-151 on line 3 instead of at an XPath. No XML, no PDF, no I/O.
Documentation

๐Ÿ‡ช๐Ÿ‡บ en16931

The EN 16931 semantic data model and its business rules, as Rust types.

billing proves an invoice is arithmetically correct. This crate proves it is legally meaningful โ€” and hands a typed proof of that to the syntax layer.

   โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”   โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
   โ”‚   billing    โ”‚   โ”‚   your ERP  โ”‚
   โ”‚ calculations โ”‚   โ”‚             โ”‚
   โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜   โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”˜
          โ”‚ adapter (feature)โ”‚
          โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                    โ–ผ
        โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
        โ”‚      en16931        โ”‚   โ† this crate. Complete on its own:
        โ”‚  semantic model     โ”‚     build an Invoice, get a verdict.
        โ”‚  validation engine  โ”‚     10 deps, no XML, no I/O, wasm32.
        โ”‚  proof of validity  โ”‚
        โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                  โ”‚  Validated<P> โ€” the typed proof
                  โ–ผ
   โ•ญ โ”€ only if you exchange documents โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ•ฎ
        โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
   โ”‚    โ”‚   en16931-formats   โ”‚  parses inbound UBL/CII,   โ”‚
        โ”‚  UBL ยท CII ยท PDF/A  โ”‚  writes outbound, +1 339
   โ”‚    โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜  syntax rules                โ”‚
    โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€ โ”€

This crate never sees a document, and most users need nothing else. If your system already has the invoice as data โ€” from billing, from an ERP, from your own types โ€” en16931 gives you the verdict and the typed proof, and that is the whole job.

Parsing an inbound UBL or CII file, or producing one, is en16931-formats's job. It is a separate crate because it depends on this one โ€” so rustc forbids the reverse, and "the semantic rules do not depend on a syntax" is enforced rather than promised. The practical payoff is the dependency line above: adding an XML parser would end that, and adding a PDF parser takes the graph to 56 crates and breaks wasm32 outright.

Status: complete against every rule set it claims. Not "supports XRechnung" โ€” 41 of 41 KoSIT rules, asserted against KoSIT's own Schematron by a test.

Profile Rules run Coverage of its authority's artefact
EN 16931 core 225 223 / 223 CEN syntax-independent
XRechnung 3.0 280 55 / 55 KoSIT asserts + 21 / 21 merged Peppol
XRechnung 3.0 CVD 287 + 8 / 8 Clean Vehicles Directive
XRechnung 3.0 Extension 289 + 14 / 14 BR-DEX-*
Peppol BIS Billing 3.0 271 46 / 46 PEPPOL-EN16931-*

And โ€” the part that matters โ€” the rules agree with the authorities' own conformance suites, not just with their rule lists:

Suite Assertions Agreement
CEN Invoice/CreditNote unit tests 1 017 run 100 % (11 declared divergences)
KoSIT XRechnung mutation suite 382 run 100 %
Published example invoices 58 documents 100 % valid

316 rules registered; 53 retired by the type system, 4 undecidable (CEN binds them to true() too), and every one of the remaining 259 exercised by its own failing fixture. Plus the ten semantic data types, eighteen generated code lists, the typed Validated<P> proof, the standard's own Annex A worked examples โ€” and the billing adapter.

Out of scope and named rather than dropped: the 1 339 syntax rules (UBL-*, CII-*) belong to en16931-formats, and Peppol's ~90 national rules (DK-R-*, SE-R-*, โ€ฆ) are country registry-format and check-digit checks.


โœ… Checked against the authorities' own conformance suites

Every other test here was written by the same person as the code it checks, from the same reading of the same documents. These two were not.

CEN's unit tests โ€” 277 files, 1 131 assertions, each a minimal UBL fragment with an explicit expectation:

<test>
  <assert><error>BR-01</error></assert>
  <Invoice> โ€ฆ no CustomizationID โ€ฆ </Invoice>
</test>

Published example invoices โ€” the 58 complete invoices CEN and OpenPeppol ship as examples of correct usage. No per-rule expectation, just a blunt one: the authority publishes this as valid, so nothing fatal may fire. That is the assertion a corpus of deliberately-broken documents structurally cannot make โ€” it is the only thing that catches a rule which is merely too eager.

KoSIT's mutation suite โ€” 224 complete, valid XRechnung invoices with mutations embedded as processing instructions:

<?xmute mutator="remove" schematron-invalid="xrubl:BR-DE-15" ?>
<cbc:BuyerReference>90000000-03083-12</cbc:BuyerReference>

Remove BT-10 and BR-DE-15 must fire. identity asserts the unmutated invoice is clean โ€” which catches rules that are too eager, the failure mode a corpus of deliberately-broken documents cannot see.

Running them needs a UBL reader, which lives in tests/ubl.rs โ€” test-only, so it is not in this crate's API, dependency graph or wasm build. It records every element it does not map, and a test asserts that set is empty.

Five real bugs came out of the first run, none of which any other test in this repository could have found:

BR-CL-15 checked BT-80; its artefact context is cac:OriginCountry โ€” BT-159. It had been duplicating BR-CL-14 and leaving BT-159 unchecked.
BR-CO-09 checked seller and buyer, not BT-63 โ€” which the rule text names.
BR-CO-25 fired on credit notes. CEN has six cases titled "Verify that rule does not fire on Credit Notes".
BR-CL-07 covered BT-128 and not BT-18 โ€” its context is a union of the two.
BR-DE-18 missed the second half of the rule: the Skonto block must end with a newline.
PEPPOL-EN16931-R003 modelled as "BT-10 is mandatory". It is a disjunction โ€” BT-10 or BT-13 โ€” and rejected eight of CEN's own published invoices.
PEPPOL-EN16931-R004 modelled as "BT-24 is present". It constrains BT-24's value with starts-with, so any string passed.
BR-CL-22 compared BT-121 case-sensitively. The released artefact wraps it in upper-case(); only the source file does not.

BR-CO-25 forced a model change. CEN's credit-note cases carry no BT-3 at all, so inferring the document kind from the type code cannot answer the question they ask. DocumentKind is now an explicit field โ€” which is also what both syntaxes carry, and it makes BR-CL-01 exact rather than permissive.

The 13 divergences are declared, not ignored

All from one cause: UBL can carry a group that is present and empty โ€” <cac:PostalAddress/> โ€” and this model cannot. An address with no fields is an absent address; there is no third state. Adding one would put a syntax artefact in every consumer's way to satisfy six test cases. The table is asserted exactly, so it can only shrink.


Why another e-invoicing library

Every existing implementation โ€” phive, Mustangproject, the KoSIT validator โ€” is XML in, Schematron out. You cannot ask them anything until you have serialised a document, so the loop is build โ†’ serialise โ†’ validate โ†’ parse the error โ†’ guess which field it meant.

This crate validates the model. A finding points at lines[3] BT-151, not at an XPath, and you can check an invoice you are still assembling.

That buys four things nothing XML-first can offer:

  1. Whole rule families become unrepresentable. All 21 BR-DEC-* rules die to a two-decimal type, and 15 more presence rules die to non-Option fields โ€” 36 rules retired by the type system, not by a predicate. They stay in the registry so explain works and a report can say they were checked.
  2. A proof that survives the call boundary. Validated<XRechnung> will mean a serialiser physically cannot be handed an unchecked invoice.
  3. Cross-edition answers. "Valid today, and still valid under XRechnung 4.0?" is one call, not two pipelines.
  4. ยตs, not ms, and no JVM โ€” plus wasm32, so the invoice never has to leave the client.

What we do not claim to beat: a Schematron-driven tool is, by construction, exactly as correct as the artefact. Our rule logic is hand-written, so it can be wrong in ways theirs cannot. That is why the conformance corpus gates every release โ€” and why the crate reports its own coverage rather than implying it:

conformance corpus
  registered:            149
  retired by the types:   36  (no state can make them fire)
  checkable:             113
  exercised by a case:   113  (100% of checkable)
  declared uncovered:      0

A rule nobody has seen fire may be inverted, unreachable, or checking the wrong field โ€” and the suite would be green either way. So every registered rule either has a fixture that makes it fire, or is a rule the type system retires and no document can trigger. There is no third category: the gate fails if a rule is uncovered and undeclared, if a declared rule has since been covered, and if anything is declared for a reason other than being type-retired. The excuse list has no room in it.


Design invariants

  • No f64. Amounts are fixed-point; rates and quantities are Decimal.
  • No I/O, no async, no unsafe. #![forbid(unsafe_code)], wasm32 tested.
  • Rounding is never implicit. An amount that does not fit two decimals is an error, not a rounding opportunity.
  • Mandatory means non-Option. Rules exist for the cardinalities the type system cannot express, not as a substitute for it.
  • Types enforce representability; rules enforce validity. An invalid document must still be representable, or a parser cannot load it in order to explain what is wrong.
  • Two dependencies by default: rust_decimal and thiserror.

๐Ÿ’ถ InvoiceAmount โ€” where 21 rules go to die

EN 16931-1 ยง6.5.2 does not merely restrict amounts to two decimals; it defines the semantic type that way:

EN 16931_ Amount. Type is floating up to two fraction digits.

Table 26 then lists every term it applies to, and the CEN artefacts render that table as 21 assertions โ€” BR-DEC-01, -02, -05, -06, -09..-20, -23..-25, -27, -28. A type that cannot hold a third decimal retires all of them at compile time.

use en16931::InvoiceAmount;

let net = InvoiceAmount::parse("1000.00")?;
let vat = InvoiceAmount::parse("190.00")?;
assert_eq!(net.checked_add(vat)?.to_string(), "1190.00");

// Refused, not rounded โ€” neither 0.01 nor 0.00.
assert!(InvoiceAmount::parse("0.005").is_err());
# Ok::<(), Box<dyn std::error::Error>>(())

Every operation is checked_: an invoice total that overflows is a data error worth surfacing, never a number worth guessing.

โ€ฆand where it must not be used

Unit Price Amount (ยง6.5.3) is a different semantic type โ€” based on Amount, but with no cap. Its own example in the standard is 10000.1234.

use en16931::{InvoiceAmount, UnitPriceAmount};
use rust_decimal::dec;

let price = UnitPriceAmount::new(dec!(0.28901));   // EUR/kWh
assert_eq!(price.to_string(), "0.28901");

// The same value as an Amount would be refused outright.
assert!(InvoiceAmount::from_decimal_exact(dec!(0.28901)).is_err());

โœ… Validating

use en16931::{validate, prelude::*};

let invoice = Invoice::default();          // nothing filled in
let report = validate(&invoice);

assert!(!report.is_valid());
assert!(report.has("BR-02"));              // no invoice number
assert!(report.has("BR-16"));              // no invoice line

// Findings point at business terms, never at an XPath.
assert_eq!(report.fatal().next().unwrap().path.to_string(), "BT-1");

A ValidationReport carries every finding, ordered stably so a CI diff means something. report.into_result()? is there for the ergonomic path, but the report is the product โ€” a rejection from a clearing platform lists every problem, and a validator that reports one is a validator you run in a loop.

Rule ids normalise, because the standard and the artefacts spell them differently:

use en16931::validation::rules;

// EN 16931-1 writes `BR-CO-4`; the CEN artefacts write `BR-CO-04`.
assert_eq!(rules::explain("BR-CO-4").map(|r| r.id.as_str()), Some("BR-CO-04"));
assert_eq!(rules::explain("br-1").map(|r| r.id.as_str()), Some("BR-01"));

The nine VAT category families

EN 16931-1 ยง6.4.3 writes these as nine parallel tables with the same ten row headings. BR-S-08 and BR-Z-08 are the same sentence with a different category and a different answer to "may this category appear at several rates".

So the logic lives in one checker per row, parameterised by a table, and the rule entries are emitted per category by a macro โ€” each keeping its own real id, because a report saying BR-CATEGORY-08 would be useless to look up.

Row Taxed (S, L, M) Zero-tax (Z, E, AE, K, G, O)
-01 groups at least one โ€” may repeat per rate exactly one
-05/06/07 rate S > 0; L/M โ‰ฅ 0 = 0, except O which must be absent
-08 base grouped by (category, rate) grouped by category alone
-09 tax = base ร— rate, ยฑ1.00 = 0, exact
-10 reason forbidden required

Every column differs, which is exactly why the standard writes nine tables rather than one parameterised rule.

BR-*-08 is the keystone โ€” the only rule tying invoice lines to the VAT breakdown, and therefore the only thing that turns a mis-attributed line into a reported error rather than a silently wrong invoice.

The four tolerance regimes

Impossible to get right from the standard's prose, and where a hand-written engine most easily diverges from the Schematron everyone else runs:

Regime Rules Tolerance Whose Where
Totals chain BR-CO-10 โ€ฆ BR-CO-16 exact CEN core
VAT derivation BR-CO-17, BR-*-08/09 ยฑ1.00, on absolute values CEN artefacts core
Line & allowance derivation R120, R040 ยฑ0.02 Peppol Profile::extra_rules
โ€ฆthe same rules, in HUF R120, R040 ยฑ0.5 XRechnung Profile::extra_rules

None of it is in the standard. EN 16931-1 ยง6.4.2 states BR-CO-17 as a plain equation with no slack; the ยฑ1.00 is an artefact decision, the ยฑ0.02 a Peppol one, and the ยฑ0.5 XRechnung's โ€” it rewrites Peppol's constant to if($documentCurrencyCode = 'HUF') then 0.5 else 0.02 when it merges the rules in, because HUF has no minor unit in practice. Peppol never widens it.

So the same forint invoice can be a valid XRechnung and an invalid Peppol document. That is why tolerance is a property of the rule instance a profile holds, never a crate-wide constant โ€” and why each rule records its Source.

All four are implemented and pinned in both directions:

// Exact โ€” one cent out is fatal.
BR-CO-14:  BT-110 = 19.01 against ฮฃ BT-117 = 19.00   โ†’ fires

// ยฑ1.00 on absolute values, which is what lets credit notes pass.
BR-CO-17:  BT-117 = 18.50 against 100.00 ร— 19%       โ†’ passes
BR-CO-17:  BT-117 = 17.50                            โ†’ fires

// ยฑ0.02, Peppol only.
R120:      BT-131 = 100.02 against 1 ร— 100.00        โ†’ passes
R120:      BT-131 = 100.03                           โ†’ fires
R120 under Profile::core()                           โ†’ not a rule at all

R120 has no CEN counterpart: EN 16931 never ties BT-131 to quantity ร— price, so under the core profile a line whose amount does not follow from its price is perfectly valid. And R046 is the trap โ€” it looks like R040's sibling and carries no slack at all.


๐Ÿ”Œ From billing

billing owns the arithmetic. This crate owns what the arithmetic means. The caller owns the parties โ€” a tariff engine has no business knowing a buyer's postal address.

let invoice = FromBilling::new(&billing_document)
    .specification_id(profiles::XRECHNUNG.specification_id)
    .seller(seller)
    .buyer(buyer)
    .build()?;

validate(&invoice).into_result()?;

There is deliberately no TryFrom. A BillingDocument has no seller, no buyer, no addresses, no country codes and no item names โ€” LineItem::description is display text, not BT-153. A TryFrom would fail on every realistic input, which makes it a trait impl whose only behaviour is Err while implying that conversion is total.

The levy trap

The reason the adapter is not a field-for-field copy. A per-unit excise โ€” Stromsteuer, a COโ‚‚ levy โ€” is produced by a TaxLayer, so it lands in tax_total. But EN 16931 counts it inside the taxable base: it is a BG-21 document level charge, not tax.

Map tax_total โ†’ BT-110, the obvious thing to do, and BR-CO-14 (BT-110 = ฮฃ BT-117) fails on every levy-bearing invoice.

BT-106  ฮฃ line net amounts        โ† net positions
BT-107  ฮฃ allowances              โ† discount positions (stated positive)
BT-108  ฮฃ charges                 โ† the levy
BT-109  = BT-106 โˆ’ BT-107 + BT-108
BT-110  = ฮฃ BT-117                โ† VAT only
BT-112  = BT-109 + BT-110         โ† equals billing's gross_total

net_total appears nowhere: it is BT-106 โˆ’ BT-107, which EN 16931 has no term for. That is the single most valuable thing the upstream work clarified.

The ยง14c hole

A final invoice deducting advance payments must, in Germany, state "die auf sie entfallenden Steuerbetrรคge" โ€” the tax in each advance (ยง14 Abs. 5 Satz 2 UStG). Omit it and the issuer owes that tax a second time under ยง14c Abs. 1.

Core EN 16931 has nowhere to put it: BT-113 is one flat figure. So an adapter that maps itemised advances to BT-113 and drops the rest produces a document that validates perfectly and is a tax liability.

Extensions carries it โ€” mirroring ZUGFeRD EXTENDED's BG-X-45, the only standardised home โ€” and EN-EXT-01 warns when the target profile cannot represent it:

EN 16931 validation โ€” 225 rule(s) checked, 1 finding(s), valid
  [EN-EXT-01] BT-113 โ€” This invoice carries extension data that the target
  profile cannot represent. [โ€ฆ] In Germany that is a ยง14c Abs. 1 UStG liability.

Not fatal: the invoice is lawful. But not silent either.

Three conversions that are not copies

Rates billing stores 0.19 because that is what you multiply by; EN 16931 stores 19, what you print. Converted once, here.
Signs billing models a return as Sign::Credit with a non-negative quantity. EN 16931 puts the sign on BT-129 and forbids a negative BT-146 (BR-27) โ€” Annex A.1.6. A negative unit price gets flipped onto the quantity rather than dropped.
Precision Refused, never rounded โ€” and the error names the fix (.amount_scale(AmountScale::EN16931)) rather than the symptom.

Units are resolved from Quantity::code first, falling back to a small UnitResolver table. An unresolvable label is an error: guessing produces an invoice that validates and describes the wrong thing, and unlike a wrong amount nobody notices.


๐Ÿ‡ฉ๐Ÿ‡ช Profiles โ€” a CIUS is a set of restrictions

Every Schematron-based tool models a CIUS as "core rules plus extra rules", because Schematron has no other vocabulary. That is not how EN 16931 defines one.

ยง7.3.2 is a normative table of the thirteen kinds of change a CIUS may make across six axes. Only one of those axes is "add a rule." The other five are restrictions on the model โ€” so they are data here, and the rules are derived:

use en16931::profiles;
use en16931::validation::profile::Restriction;

// Eleven of XRechnung's BR-DE rules are pure `Mandatory` restrictions, and two
// are `CodeValues`. All thirteen are data, not code; the other 28 need code.
let ids: Vec<_> = profiles::XRECHNUNG.restrictions.iter().map(Restriction::id).collect();
assert!(ids.contains(&"BR-DE-3"));    // Seller city (BT-37) shall be present
assert!(ids.contains(&"BR-DE-17"));   // BT-3 restricted to eight codes

Each keeps its real published id, so a finding is lookup-able in KoSIT's index โ€” and the path still names the business term:

[BR-DE-3] BG-4/BT-37 โ€” Seller city (BT-37) shall be present

Two properties this buys

A CIUS can be checked for conformance. ยง4.4.2 requires that "the resulting invoice document instance shall be fully compliant to the core invoice model". Every Restriction variant is by construction a narrowing, so a profile that tried to loosen something cannot be expressed. Loosening is an Extension (ยง4.3, CEN/TR 16931-5) โ€” a different mechanism.

Validation widens for free. ยง4.4.4 says an instance complying with a conformant CIUS "can still be received and processed by a party who is not supporting the CIUS". So the proof converts, infallibly:

let proof: Validated<XRechnung> = Validated::new(invoice)?;
serialise_xrechnung(&proof);        // demands the CIUS proof
accepts_core(proof.widen());        // ยง4.4.4 โ€” free, no re-validation

Enums retire rules too

BR-DE-23-b, -24-b and -25-b each forbid the two payment groups BT-81 did not name. Because PaymentMeans is an enum over BG-17 / BG-18 / BG-19, that combination cannot be written down โ€” so all three have nothing left to check.

The -a halves stay real: they tie the variant to BT-81's value, which no type can see.

pub enum PaymentMeans {
    CreditTransfer(Vec<CreditTransfer>),  // BG-17
    Card(PaymentCard),                    // BG-18
    DirectDebit(DirectDebit),             // BG-19
}

Offline checks that are worth doing

BR-DE-19 and -20 want a correct IBAN. This crate implements ISO 7064 mod-97-10 โ€” no registry, no network, so it still runs on wasm32. It cannot tell you the account exists, only that the string is not a typo, which catches the overwhelming majority of real errors.

Both are warnings, matching KoSIT's soll: a suspicion, not a rejection.

Not levels โ€” siblings

It is tempting to model these as an ordered scale. There is no such order, and the crate's tests pin it: XRechnung permits BT-3 = 389 (self-billed) and Peppol does not; Peppol permits 386 (prepayment invoice) and XRechnung does not. Neither is "more restrictive".

The sharpest case is BT-119. CEN's BR-48 exempts category O from stating a VAT breakdown rate; XRechnung's BR-DE-14 requires it unconditionally. Suppressing BT-119 for O โ€” on the strength of BR-O-05, which governs BT-152, a different term โ€” is the natural mistake, and it fails the KoSIT validator.

XRechnung merges 31 of Peppol's rules โ€” and rewrites two

The Schematron in KoSIT's repository contains only BR-DE-*, BR-DEX-* and BR-TMP-*. That file is an input, not the artefact. The build runs peppol-into-xr.xsl over it, splicing in every Peppol assert named in rule-list.xml, and that is what ships:

<target name="merge-peppol-rules-with-xr-rules">
  <xslt in="โ€ฆ/XRechnung-UBL-validation.sch" style="โ€ฆ/peppol-into-xr.xsl" โ€ฆ/>

31 of Peppol's 46. The fifteen left out are CL001โ€ฆCL008 (Peppol's own narrower code lists) and P0104โ€ฆP0112 (the VATEX-to-category pinning, plus the German-parties type-code rule that would be circular inside a German CIUS).

Two are rewritten on the way in, and both differences are observable:

Peppol XRechnung
R120 severity fatal warning
R040 / R120 slack 0.02 always 0.5 for HUF, 0.02 otherwise

HUF has no minor unit in practice, so 0.02 is tighter than the currency can express โ€” and Peppol never widens it. The same forint invoice can be a valid XRechnung and an invalid Peppol document, so the two profiles hold separate instances of those rules rather than sharing one.

This reverses what this crate concluded one revision earlier, from reading KoSIT's validator configuration:

<resource>โ€ฆ/EN16931-UBL-validation.xsl</resource>   <!-- CEN's -->
<resource>โ€ฆ/xsl/XRechnung-UBL-validation.xsl</resource>   <!-- its own -->

Two Schematrons, no Peppol โ€” which is true, and does not mean what it looks like. The second one already contains Peppol's rules by the time the validator loads it.

A CIUS restricts; an Extension adds โ€” and KoSIT ships one of each

profiles::XRECHNUNG_EXTENSION is ยง4.3's second mechanism in the wild. Where the CIUS narrows, it widens:

Core / CIUS Extension
BT-125 mime code six codes + application/xml
scheme identifiers ISO 6523 ICD / CEF EAS + XR01โ€“XR03 (DiGA)
BT-115 BR-CO-16 BR-DEX-09 โ€” third-party payments added back

and it adds two groups the core model has no term for: BG-DEX-01 sub-invoice lines, for positions that decompose, and BG-DEX-09 third-party payments, for the German digital-health case where a statutory insurer settles part of an invoice addressed to the insured. Both live in en16931::extensions, not on InvoiceLine โ€” a core line has no child, and putting one there would make every consumer carry a field only one Extension populates.

Because it widens, ยง4.4.4's guarantee does not run: an Extension-valid invoice need not be core-valid, so there is deliberately no Underlies<XRechnungExtension> for En16931.

The CVD variant is the awkward case. Its identifier says #compliant# โ€” ยง4.3's word for a CIUS โ€” but BR-TMP-CVD-01 checks BT-158's scheme against UNTDID 7143 plus CVD, and CVD is not in UNTDID 7143. So a conforming CVD invoice violates core BR-CL-13, which a CIUS may not cause. This crate follows the behaviour rather than the label: BR-CL-13 suppressed, BR-TMP-CVD-01 in its place. Reporting BR-CL-13 on every CVD invoice would be a false positive on a document KoSIT accepts.


๐Ÿ“… Date โ€” a calendar day, not an instant

ยง6.5.9 is unusually explicit, and both halves matter:

Dates shall be in accordance to the "Calendar date complete representation" as specified by ISO 8601. Calendar dates do not include a specification for the time of the day.

use en16931::Date;

let from = Date::parse("2026-06-01")?;
let to   = Date::parse("2026-06-30")?;
assert!(to >= from);                                   // BR-29

assert!(Date::parse("2026-02-30").is_err());           // not a real day
assert!(Date::parse("2026-06-01T00:00:00").is_err());  // ยง6.5.9: no time of day
# Ok::<(), Box<dyn std::error::Error>>(())

Three integers, no timezone โ€” there is nothing to offset, and shifting BT-2 by a zone changes the VAT period it falls in. Enable chrono or time for conversions; the default build carries neither.


๐Ÿ“Š Percentage โ€” per cent, never a fraction

Percentages are given as fractions of a hundred (per cent) e.g. the value 34,78 % in percentage terms is given as 34,78. โ€” ยง6.5.5

use en16931::Percentage;
use rust_decimal::dec;

let vat = Percentage::new(dec!(19));      // nineteen per cent, NOT 0.19
assert_eq!(vat.to_string(), "19");
assert_eq!(vat.as_fraction(), dec!(0.19)); // what you multiply by

This is the most common transcription bug when bridging a calculation engine: billing stores 0.19 because that is what you multiply by; the standard stores what you print. Convert once, at the boundary.

Trailing zeros need no special handling โ€” rust_decimal compares by value, so 19 and 19.00 are one VAT breakdown group in Eq, Ord and Hash. The crate pins that with a test, because a Hash disagreeing with Eq here would be a silent, data-dependent grouping bug.


๐Ÿ”ข Quantity โ€” and why it may be negative

Annex A.1.6 (Example 5 โ€” Negative Invoice line) invoices 25 cases of pens and credits 10 returned ones on the same ordinary invoice:

BT-126 BT-129 BT-146 BT-131
1 25 8,50 212,50
2 โˆ’10 8,50 โˆ’85,00

The sign lives on the quantity, never on the price โ€” BR-27 forbids a negative item net price.

use en16931::Quantity;
use rust_decimal::dec;

let returned = Quantity::new(dec!(-10));
assert!(returned.is_negative());

The proof has to be earned

let proof: Validated<XRechnung> = Validated::new(invoice)?;
let core: Validated<En16931>    = proof.widen();   // infallible โ€” ยง4.4.4

Widening is free only from a conformant CIUS, and Profile::is_conformant_cius() is the runtime witness. It answers false for two shipped profiles: the CVD variant and the Extension both suppress a core rule, so a document either accepts may violate the core model.

That method used to return a constant true, with a test asserting it for every profile โ€” a tautology that passed and was wrong about two of the five. It hid a real bug: impl Underlies<XRechnungCvd> for En16931 existed, so Validated<XRechnungCvd>::widen::<En16931>() compiled and produced a proof of core-validity for an invoice violating BR-CL-13. A serialiser trusting the core proof โ€” the entire purpose of Validated<P> โ€” would have been handed a document no core-only receiver can process.

Both impls are gone, and tests/robustness.rs now asserts the surviving guarantee over arbitrary generated documents rather than one fixture: if a conformant CIUS accepts it, core accepts it.


โšก Measured, not asserted

validate/core/5                      1.47 ยตs      โ† the 5-line invoice
validate/core/1000                 132.9  ยตs      โ† linear in line count
profile/EN 16931/5                   2.30 ยตs
profile/XRechnung 3.0/5              4.64 ยตs
profile/XRechnung 3.0 Extension/5    5.95 ยตs

cargo bench. The target was "well under 100 ยตs for a typical 5-line invoice through the full core rule set"; it is 1.5 ยตs, and profile validation โ€” 280 rules for XRechnung โ€” is under 5.

Writing the benchmark immediately found a defect it existed to catch: Profile::validate was 35 ยตs on the same document the core rules took 1.5 ยตs on, for a profile that adds no rules at all. Comparing two rule ids built up to three Strings, and profile validation does that once per rule per document. Making the comparison allocation-free and skipping the intermediate Vec took it to 2.3 ยตs โ€” 15ร—, and 35ร— for the Extension profile.

A performance claim in a README is worth exactly as much as the benchmark behind it. This one had none until it had a bug.


โš–๏ธ Deviations are allowed โ€” and loud

Real counterparties demand them. A buyer who will not send BT-10 does not care that BR-DE-15 requires it, and refusing outright just pushes people to fork the rule set or ignore the validator.

use en16931::{Invoice, profiles, validation::Check};

let report = Check::new(&profiles::XRECHNUNG)
    .without("BR-DE-15")             // the buyer will not send BT-10
    .run(&Invoice::default());

assert_eq!(report.suppressed(), ["BR-DE-15"]);
XRechnung 3.0 validation (EN 16931-1:2017+A1:2019) โ€” 279 rule(s) checked, 27 finding(s), INVALID
  โš  1 rule(s) suppressed and NOT checked: BR-DE-15

The suppressed ids are on the report, printed by Display, carried in the JSON, and rules_checked drops โ€” so a stored report cannot overstate what ran.

And a deviated run cannot produce a proof. Check::prove refuses:

Check::new(&profiles::XRECHNUNG).without("BR-DE-15").prove::<XRechnung>(inv)
// Err(ProveError::Suppressed(["BR-DE-15"]))

That is the XRECHNUNG_CVD lesson at runtime. A rule set with a hole may accept documents the full set rejects, so a Validated<P> derived from it would claim something untrue. Validated<P> means the whole rule set passed โ€” if it could also mean most of it, no consumer could rely on it and the type would be decoration.


๐Ÿงญ The other crate

en16931-formats carries the syntax layer โ€” the UBL 2.1 and CII bindings in both directions, the 1 339 syntax rules, the XRechnung CIUS, and ZUGFeRD / Factur-X hybrid PDFs โ€” behind features, so a consumer that wants UBL does not compile a PDF parser. It is what parses an inbound document into the Invoice these rules run against, and what turns a Validated<P> back into bytes.

One crate there, not three. XRechnung is carried in UBL and CII, and every ZUGFeRD payload is CII: a crate per format would need the CII binding twice, and two bindings drift. Cargo features already express which syntax a consumer wants.

But it is a separate crate from this one, and that boundary is load-bearing. It depends on en16931, so rustc forbids the reverse: "the semantic rules do not depend on a syntax" is enforced rather than promised. The payoff is measurable โ€” this crate's graph is 10 crates and builds for wasm32; adding an XML parser would end the first claim and a PDF parser takes it to 56 crates and breaks the target outright.


๐Ÿ“ค A report you can store, diff and ship

Two shapes: a versioned JSON one, and โ€” behind features = ["svrl"] โ€” SVRL, which every Schematron tool in this field already speaks.

<svrl:schematron-output title="EN 16931 โ€” XRechnung 3.0" schemaVersion="EN 16931-1:2017+A1:2019">
  <svrl:failed-assert id="BR-02" flag="fatal" location="BT-1" test="en16931:BR-02">
    <svrl:text>An Invoice shall have an Invoice number (BT-1).</svrl:text>
  </svrl:failed-assert>
</svrl:schematron-output>

That feature adds no dependencies. SVRL is a report format, not an invoice syntax: writing it needs escaping, not a parser, and no UBL or CII element names. The "no XML" rule is about never learning a syntax binding โ€” this crate still could not parse an invoice if it wanted to.

location carries a business-term path rather than an XPath, and the output says so in a comment: there is no source document to point into. Everything reading SVRL for which rules failed and why works unchanged.

use en16931::{Report, Invoice, profiles};

let report = profiles::XRECHNUNG.validate(&Invoice::default());
let out = Report::of(&report);
assert_eq!(out.schema, "en16931-report/1");
assert_eq!(out.profile.as_deref(), Some("XRechnung 3.0"));
{
  "schema": "en16931-report/1",
  "valid": false,
  "profile": "XRechnung 3.0",
  "edition": "EN 16931-1:2017+A1:2019",
  "rulesChecked": 280,
  "attribution": "implementation of the EN 16931-1 semantic data model; โ€ฆ",
  "findings": [
    { "rule": "BR-02", "severity": "fatal", "source": "standard+artefact",
      "location": "BT-1", "text": "An Invoice shall have an Invoice number (BT-1)." }
  ]
}

ValidationReport derives Serialize, but that shape is the crate's internals and changes when they do. Report is a separate, versioned shape โ€” the internal layout may change freely, this one only by bumping schema.

It is designed against SVRL rather than invented. Every Schematron tool in the field emits <svrl:failed-assert id flag location> with a <svrl:text>, and each maps one-to-one, so an en16931-svrl crate is a rename rather than a translation. One field deliberately differs: SVRL's location is an XPath into a serialised document, and this crate's is a business-term path (BG-25[2]/BT-151). A crate holding the XML can map BT โ†’ XPath; the reverse is lossy, so the semantic form is the one worth storing.

Two things travel with it that SVRL has no room for: the provenance of each rule โ€” CEN's, a profile's, or this crate's โ€” and which profile and edition produced the report. A stored report that cannot say what it was checked against is close to useless six months later.


๐Ÿ”Ž Every finding can be explained

use en16931::validation::rules::{explain, explain_restriction};

assert_eq!(explain("BR-CO-3").map(|r| r.id.as_str()), Some("BR-CO-03"));   // padding
assert_eq!(explain("BR-IG-8").map(|r| r.id.as_str()), Some("BR-AF-08"));   // family alias
assert!(explain("PEPPOL-EN16931-R120").is_some());
assert!(explain_restriction("br-de-3").is_some());                          // a restriction

Rules are data โ€” id, severity, provenance, the business terms they touch, and the standard's own wording โ€” so the registry is listable, filterable and explainable. touching(BtId(117)) answers "which rules constrain BT-117".

explain used to search the core set only, so an ordinary XRechnung report citing BR-DE-16 or PEPPOL-EN16931-R120 resolved to None for every id in it. A registry that cannot explain its own findings is not a registry. It now searches every rule the crate ships, and explain_restriction covers the profile restrictions, which are data rather than predicates and so have no Rule to hand back.


๐Ÿ”’ Invariants survive serde

serde_json::from_str::<InvoiceAmount>(r#""1.234""#).is_err()   // three decimals
serde_json::from_str::<Date>(r#""2026-06-30T12:00:00Z""#).is_err()  // an instant

A derived Deserialize rebuilds private fields without calling the constructor, which would make "types enforce representability" true everywhere except the one boundary where untrusted data arrives. The types with invariants use #[serde(try_from = โ€ฆ)] so deserialisation re-runs the check.

That was advertised in Cargo.toml and untested. Writing the test found that Attachment enforced nothing at all: the docs said "mime code and filename mandatory" per ยง6.5.11 and Attachment::new happily accepted "" for both. Nothing else caught it either โ€” the only rule requiring a filename is UBL-DT-07, a syntax rule this crate deliberately does not implement. It is a Result now.


๐Ÿ›ก๏ธ It does not panic

proptest! {
    #[test]
    fn validate_never_panics(inv in any_invoice()) { โ€ฆ }
}

A clearing platform does not choose its inputs. tests/robustness.rs generates structurally valid, semantically absurd documents โ€” i64::MAX amounts that overflow when summed, zero base quantities that R120 would divide by, empty codes, thousands of lines โ€” and asserts that validation terminates, never panics, is deterministic and stably ordered, and never cites a rule id that explain() cannot resolve.

proptest rather than cargo-fuzz on purpose: it runs in the ordinary suite on every commit. A property that only runs when someone remembers is a property that regresses.


๐Ÿ“… Editions are values, not crate versions

use en16931::{profiles, Edition};

assert_eq!(profiles::XRECHNUNG.edition, Edition::En2017A1);
assert_eq!(Edition::En2017A1.designation(), "EN 16931-1:2017+A1:2019");

EN 16931-1:2026 is published and 2017 formally withdrawn โ€” but every deployed validator (XRechnung 3.0.2, Peppol BIS 3.0, ZUGFeRD 2.x) is a usage specification of 2017+A1:2019. Leading with :2026 would produce a crate that fails all of them.

So the edition is a property of the profile, and a document declares its profile in BT-24 โ€” which means for_specification_id recovers the edition from the document itself. When XRechnung 4.0 arrives it is a new Profile, a minor release, not a new crate.

Edition::En2026 exists as a classification and no profile declares it: a test fails the build if one does without a rule set to go with it. The term-level half โ€” which business terms :2026 introduces, and the EN-EDITION-01 rule that forbids populating them under a 2017 profile โ€” waits on the normative text. Writing that map from memory is how you ship a validator that is confidently wrong.


๐Ÿ”— Optional: stronger payment identifiers via sepa

BR-DE-19 and BR-DE-20 say BT-84 and BT-91 "should contain a valid IBAN". By default that check is ISO 7064 mod-97-10 โ€” correct, and blind to length: a 21-character German IBAN with consistent check digits passes, and no German bank will take it.

en16931 = { version = "0.1", features = ["sepa"] }

turns it into the full ISO 13616 registry โ€” 89 countries, each with its own length and BBAN structure โ€” and adds EN-SEPA-01, this crate's own warning that BT-90 is a well-formed EPC AT-02 creditor identifier. No rule anywhere checks that, yet a direct debit quoting a malformed creditor identifier is rejected by the bank long after the invoice was accepted.

Off by default, because the default build is rust_decimal + thiserror and nothing else, and sepa brings quick-xml โ€” which this crate otherwise goes to some lengths not to have.


๐Ÿท๏ธ Code lists โ€” 4 887 values, generated and re-verified

Eighteen lists, from UNCL 5305's ten VAT categories to UN/ECE Rec 20's 2 162 unit codes. All generated from the pinned CEN artefacts by cargo xtask codegen, all re-checked against them by tests/codelists.rs, and all re-derived in CI by cargo xtask check so they cannot drift from the artefacts they came from.

The generator refuses to guess. BR-CL-01's test is a disjunction carrying two different lists, so the table declares which branch it wants and the generator fails if the shape changes. BR-CL-08's UNCL 4451 is bound differently by each of CEN's three syntaxes โ€” EDIFACT 381 codes โŠ‚ UBL 383 โŠ‚ CII 401, three frozen UNTDID directory revisions โ€” so the generator checks that they still form a chain, takes the union, and stops outright if one binding ever gains a code another dropped.

use en16931::codes::{contains, generated::UNIT_CODES};
use en16931::VatCategory;

assert!(contains(UNIT_CODES, "KWH"));
assert!(!contains(UNIT_CODES, "kwh"));   // ยง6.5.8: codes are entered exactly

assert_eq!(VatCategory::from_code("AE"), Some(VatCategory::ReverseCharge));
assert_eq!(VatCategory::from_code("ae"), None);

VatCategory carries the semantics the rules branch on:

use en16931::VatCategory;

// Both carry zero tax, but Z FORBIDS an exemption reason and E REQUIRES one.
assert!(VatCategory::ZeroRated.forbids_exemption_reason());   // BR-Z-10
assert!(VatCategory::Exempt.requires_exemption_reason());     // BR-E-10

// B is the only category with neither rule โ€” and unlike AE, it is taxed.
assert!(VatCategory::SplitPayment.carries_tax());

// Only O suppresses the LINE rate (BT-152). BT-119 is a different term.
assert!(!VatCategory::OutOfScope.states_rate());

Why the generator is paranoid

A Schematron test is a program, not a data structure. Three of the eighteen tables cannot be read off it directly, for three different reasons:

  • BR-CL-01 is a disjunction over self:: โ€” 50 codes for cbc:InvoiceTypeCode, 13 for cbc:CreditNoteTypeCode. They overlap in exactly one code (81) and are disjoint on 380/381.
  • BR-CL-10 is the ISO 6523 list plus a contextual literal: SEPA is admissible only on a party identification under cac:AccountingSupplierParty or cac:PayeeParty. It therefore belongs in the rule, not in a flat table.
  • BR-CL-08 is not in the code-list file at all โ€” UBL embeds BT-21 in the note text (#AAI#the text), so the list lives in the preprocessed binding. And the three syntaxes disagree: EDIFACT 381 โŠ‚ UBL 383 โŠ‚ CII 401, three frozen UNTDID directory revisions. A syntax-independent crate cannot know which syntax an invoice will be written to, so it takes the union โ€” rejecting a code a CEN binding accepts would be a false positive on a lawful invoice. The generator verifies the chain is still nested and stops if it ever breaks.

An extractor that reads the first contains(โ€ฆ) and stops is confidently, precisely wrong on the first two. That mistake was made during this crate's design and produced an incorrect bug report against an upstream project โ€” so the defence is a test, not a promise to be careful. The UNCL 4451 list was very nearly written from memory during the last pass of this crate's development; it would have been wrong in both directions.


๐Ÿš€ Examples

cargo run --example validate_an_invoice                    # build one, validate, read the report
cargo run --example profiles_and_proofs                    # every profile, and the typed proof
cargo run --example report_formats --features serde,svrl   # JSON and SVRL output

๐Ÿงฐ Development

just is the task runner; just on its own lists every recipe. There are no shell scripts โ€” fetching and generating are cargo xtask subcommands, so they are compiled, type-checked and linted like the rest of the crate and behave the same on every platform CI uses.

cargo xtask fetch        # โ†’ spec/ (gitignored, ~136 MB); the suites become live
cargo xtask codegen      # regenerate src/codes/generated.rs; review the diff
cargo xtask check        # fail if the committed file no longer matches
just ci                  # everything CI runs, locally

Minimum supported Rust version

1.88 โ€” the rule code uses let-chains. Measured, not declared: 1.87 fails, and CI reads the number from Cargo.toml rather than repeating it.

The artefacts

spec/ is not committed: the CEN artefacts are EUPL-1.2, a reciprocal licence, and keeping them out is what keeps this crate MIT OR Apache-2.0 โ€” which is also why deny.toml's allow-list does not mention EUPL.

The fetch pulls four repositories and nothing else: the CEN validation artefacts (pinned), Peppol BIS Billing 3.0, and KoSIT's XRechnung Schematron and validator configuration. It does not fetch specification PDFs โ€” including EN 16931-1 itself, whose full English text รšNMS SR publishes openly. Reading the standard is a research task, not a build step; spec/README.md lists the routes.

Sources are pinned by fully-qualified ref, and that is not pedantry: eInvoicing-EN16931 publishes validation-1.3.16 as both a tag and a branch pointing at different commits, and git clone --branch prefers the branch โ€” so two clones of the same "pin" produced different trees and different code lists.

The code lists are generated, not written

src/codes/generated.rs holds 4 887 values across 18 tables. The generator fails rather than guesses: a Schematron test is a program, not a data structure, and BR-CL-01 alone carries two different lists in one disjunctive expression โ€” 50 invoice type codes and 13 credit-note ones. An extractor that reads the first and stops is confidently wrong. So every table declares how its list is selected, and a rule that changes shape stops the build.

It also proves claims made in comments elsewhere: that Peppol's UNCL5189 really is identical to the CEN table, and that the three CEN bindings' UNCL 4451 lists (381 / 383 / 401 codes) really are nested โ€” so taking their union is directory drift and not a divergence being papered over. cargo xtask check runs in CI, so none of it can quietly rot.


โš–๏ธ Licence

MIT OR Apache-2.0, at your option.

Attribution

implementation of the EN 16931-1 semantic data model; ยฉ CEN, used under the 2018 CENโ€“EC licence agreement

This crate is an implementation of the semantic data model of EN 16931-1 and of the two mandatory syntaxes listed in CEN/TS 16931-2. EN 16931-1 and CEN/TS 16931-2 are made available free of charge by CEN and the European Commission under their 2018 licence agreement, which permits derivative use on condition that derivative applications carry a statement to this effect. Copyright in the standard remains with CEN.

The notice above is en16931::ATTRIBUTION, and every ValidationReport carries it verbatim. tests/attribution.rs asserts all three copies still agree โ€” because losing a licence condition by reformatting is the kind of mistake nothing else in a build would catch.