Attestwire › Rule reference › BR-CO-23

BR-CO-23 A line allowance needs a reason, a reason code, or both

noun · EN 16931 · fatal · BT-139 / BT-140

For a sample invoice, the library reports: The reason (BT-139) and the reason code (BT-140) on the invoice line allowance at lines[0].allowances[0] are individually optional terms, and this constraint — separate from BR-42, which is the cardinality rule on the group — is what rules out the one combination those cardinalities would otherwise permit: neither present.

Business term

BT-139 / BT-140

Severity

fatal

The fix

Add lines[0].allowances[0].reason, lines[0].allowances[0].reasonCode, or both. Where no UNCL 5189 code describes what you are deducting, omit the code entirely and use free text — the lists have no "other" entry, and an invented code fails BR-CL-19.

A passing value

"reason": "Special agreement", "reasonCode": "100"

What the library returns

The full error returned by @attestwire/en16931. It includes the rule ID, affected field and suggested correction. Developers can use this object in their application:

{
  "rule": "BR-CO-23",
  "field": [
    "BT-139",
    "BT-140"
  ],
  "severity": "fatal",
  "message": "The reason (BT-139) and the reason code (BT-140) on the invoice line allowance at lines[0].allowances[0] are individually optional terms, and this constraint — separate from BR-42, which is the cardinality rule on the group — is what rules out the one combination those cardinalities would otherwise permit: neither present. Supplying both is allowed and preferable, because the code is machine-actionable and the text is what a person reads.",
  "fix": "Add lines[0].allowances[0].reason, lines[0].allowances[0].reasonCode, or both. Where no UNCL 5189 code describes what you are deducting, omit the code entirely and use free text — the lists have no \"other\" entry, and an invented code fails BR-CL-19.",
  "example": "\"reason\": \"Special agreement\", \"reasonCode\": \"100\"",
  "xpath": "/ubl:Invoice/cac:InvoiceLine[1]/cac:AllowanceCharge[1]/cbc:AllowanceChargeReasonCode",
  "docsUrl": "https://attestwire.com/rules/BR-CO-23"
}

xpath is always a UBL path. On a CII invoice, look for the matching CII field instead.