Skip to main content

EinvoiceValidationCheck

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.

  • ]
    • EinvoiceValidationCheck
    {
      "kind": "rules",
      "name": "Schematron rules for CIUS XRechnung (CII)",
      "result": "passed",
      "messages": [
        {
          "part": "xml",
          "severity": "error",
          "rule": "BR-CO-25",
          "message": "string",
          "location": "string"
        }
      ]
    }