EinvoiceValidationReport

Which rules a file passed, by which validator and release, and which bytes it judged. Each check stands on its own; the report states no verdict on the document as an invoice for VAT purposes, and it does not replace the recipient's own check.

idstringnullable

The validator's own id for this report, which its log names too; null for a stored report from before 9 October 2026 and where nothing was checked.

resultstringrequired

passed: a validator ran its rules to the end and every check passed. failed: a check found an error. not_checked: no rule set here is for the file, or it was not read, or the validator did not finish; reason says which. New values may be added.

Example: passed

reasonstringnullable

Why the file was not checked: not_read (a document type, XInclude, an encoding other than UTF-8, or past a limit), unknown_root, no_customization_id, unknown_customization_id, not_offered (Peppol BIS Billing 3.0), no_scenario, rules_not_applicable, validator_stopped, not_validated or no_verdict. Null when it was checked.

Example: unknown_customization_id

explanationstringnullable

The same in a sentence that names what was found, such as the identifier.

source objectrequired

What was validated: an upload (filename, bytes), or a render (render_id, and stored: true when the answer is the render's stored report).

typestringrequired

Example: upload

filenamestringnullable

bytesinteger

render_idstring

Example: rnd_0d290c45cbeb4554b946bbad1acee87e

storedboolean

route objectnullable

What the routing table read off the file before any validator did; null when the file was not read that far.

syntaxstringnullable

Example: cii

documentstringnullable

Example: invoice

rootstringnullable

Example: CrossIndustryInvoice

customization_idstringnullable

The specification identifier (BT-24) as the file names it.

Example: urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0

rule_setstringnullable

factur-x, xrechnung or en16931; null when no rule set judged the file.

Example: xrechnung

validatorstringnullable

Example: KoSIT validator 1.6.3

rulesstringnullable

The rule set and its release, as the validator names them.

Example: XRechnung 3.0.2, configuration of 2026-08-31

scenariostringnullable

The scenario of KoSIT's configuration that judged the file; null for Mustang.

Example: EN16931 XRechnung (CII)

profilestringnullable

The Factur-X or ZUGFeRD profile Mustang held the file to; null for KoSIT.

Example: en16931

checks object[]required

Array [

kindstringrequired

syntax (the file reads as UTF-8 XML), schema (its XML schema), rules (one named rule set) or, for a render, container (the PDF/A-3b file and the invoice it carries). New kinds may be added.

Example: rules

namestringrequired

What was checked, as the validator or its configuration names it.

Example: Schematron rules for CIUS XRechnung (CII)

resultstringrequired

passed, failed (a finding of severity error) or not_run (the check did not run to its end, or never ran because an earlier one failed).

Example: passed

messages object[]required

Array [

partstring

Whether the finding is about the invoice XML or about the PDF/A file.

Possible values: [xml, pdf]

severitystring

Possible values: [error, warning]

rulestringnullable

The rule: of EN 16931 (BR-…), of the syntax binding (CII-SR-…), a code of the XML schema (cvc-…), or the clause of PDF/A (6.2.11.4.1-1). Null where the validator names none.

Example: BR-CO-25

messagestring

locationstringnullable

Where: an XPath into the XML (a line item always carries its index), a line and column for a finding of the XML schema, or the object of the PDF.

]

]

truncatedboolean

More findings than the checks show (100 each).

versions objectnullable

property name*string

xml_sha256stringnullable

SHA-256 of the XML that was judged, as it arrived.

pdf_sha256stringnullable

SHA-256 of a render's PDF its stored report judged; null for an upload.

display objectnullable

The display check of a render's PDF, as its stored report keeps it; null for an upload.

checkedstring[]

missingstring[]

validated_atstring<date-time>required

When the validator judged the file: now, or when the render was made.

allowance objectnullable

What the organisation's day of validations has used after this request; null where nothing was counted.

limitintegernullable

The plan's daily number; null where it sets no cap.

usedinteger

resets_atstring<date-time>

EinvoiceValidationReport

{
  "id": "string",
  "result": "passed",
  "reason": "unknown_customization_id",
  "explanation": "string",
  "source": {
    "type": "upload",
    "filename": "string",
    "bytes": 0,
    "render_id": "rnd_0d290c45cbeb4554b946bbad1acee87e",
    "stored": true
  },
  "route": {
    "syntax": "cii",
    "document": "invoice",
    "root": "CrossIndustryInvoice",
    "customization_id": "urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0",
    "rule_set": "xrechnung"
  },
  "validator": "KoSIT validator 1.6.3",
  "rules": "XRechnung 3.0.2, configuration of 2026-08-31",
  "scenario": "EN16931 XRechnung (CII)",
  "profile": "en16931",
  "checks": [
    {
      "kind": "rules",
      "name": "Schematron rules for CIUS XRechnung (CII)",
      "result": "passed",
      "messages": [
        {
          "part": "xml",
          "severity": "error",
          "rule": "BR-CO-25",
          "message": "string",
          "location": "string"
        }
      ]
    }
  ],
  "truncated": true,
  "versions": {
    "kosit": "1.6.3",
    "xrechnung_configuration": "2026-08-31",
    "xrechnung_schematron": "2.6.0",
    "cen": "1.3.16",
    "saxon": "12.10"
  },
  "xml_sha256": "string",
  "pdf_sha256": "string",
  "display": {
    "checked": [
      "string"
    ],
    "missing": [
      "string"
    ]
  },
  "validated_at": "2024-07-29T15:51:28.071Z",
  "allowance": {
    "limit": 0,
    "used": 0,
    "resets_at": "2024-07-29T15:51:28.071Z"
  }
}