Einvoice

profilestring

Possible values: [basic, en16931]

flavourstring

Possible values: [factur-x, zugferd]

spec_versionstring

The release of the specification the file was written and validated for, under the name of flavour: Factur-X 1.09 is ZUGFeRD 2.5.

Example: 1.09

xml_urlstring<uri>nullable

A link to the XML, made like the render's download_url (signed, or the plain URL of a public output), when the render asked for xml: both and the file is still stored. The XML is inside the PDF either way.

validation objectnullable

What the validator said about the file. Null only when the render failed before it ran.

validboolean

No finding of severity error. A render succeeds only with a valid file.

schematronstring

The rule set the XML was held to, as it names itself, and the validator that ran it.

Example: Factur-X 1.09.2 (Mustang 2.26.0)

pdfastringnullable

The PDF/A flavour the file was checked against; null when validation ended at the XML.

Example: PDF/A-3b

messages object[]

At most 50, errors first.

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

Present and true when there were more findings than messages holds.

idstring<uuid>

The validator's own id for this report. Quote it when you ask about a render; renders before 9 October 2026 have none.

Example: 6f2c7e9a-1d4b-4c3e-8a5f-2b7d9e0c1a34

versions object

The versions of the validator's parts that judged the file. The pinned versions are listed in the documentation.

property name*string

xml_sha256string

SHA-256 of the XML that was judged: the XML inside the PDF, and the file xml_url links.

Example: 3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b

pdf_sha256stringnullable

SHA-256 of the PDF that was judged. For a render that succeeded it is the delivered file and equals the render's output_sha256; null where the validator refused the XML before there was a converted file.

Example: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08

display objectnullable

The display check: the values of the XML that were looked for in the text of the PDF, by their business term in EN 16931.

checkedstring[]

Example: ["BT-1","BT-109","BT-110","BT-112"]

missingstring[]

The terms the PDF does not show. Zero amounts are not looked for.

Example: []

Einvoice

{
  "profile": "basic",
  "flavour": "factur-x",
  "spec_version": "1.09",
  "xml_url": "string",
  "validation": {
    "valid": true,
    "schematron": "Factur-X 1.09.2 (Mustang 2.26.0)",
    "pdfa": "PDF/A-3b",
    "messages": [
      {
        "part": "xml",
        "severity": "error",
        "rule": "BR-CO-25",
        "message": "string",
        "location": "string"
      }
    ],
    "truncated": true,
    "id": "6f2c7e9a-1d4b-4c3e-8a5f-2b7d9e0c1a34",
    "versions": {
      "mustang": "2.26.0",
      "verapdf": "1.30.2",
      "pdfbox": "3.0.8"
    },
    "xml_sha256": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
    "pdf_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  },
  "display": {
    "checked": [
      "BT-1",
      "BT-109",
      "BT-110",
      "BT-112"
    ],
    "missing": []
  }
}