ParseResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/invowerk-dev/json-schema/invowerk-dev-parse-response-schema.json",
  "title": "ParseResponse",
  "description": "The answer of POST /v1/parse: the invoice as JSON and what invowerk detected.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/invowerk-dev-openapi.yml#/components/schemas/ParseResponse",
  "properties": {
    "model": {
      "additionalProperties": true,
      "type": "object",
      "title": "Model",
      "description": "The invoice as JSON keyed on Business Terms. It has the schema of the POST /v1/generate request body (GenerateRequest), so you can edit it and create the invoice again."
    },
    "detection": {
      "$ref": "#/$defs/ParseDetection",
      "description": "What invowerk detected: syntax, rule set and CustomizationID."
    },
    "source": {
      "type": "string",
      "title": "Source",
      "description": "Where the XML came from: 'xml' (you sent XML) or 'pdf-embedded' (taken from a ZUGFeRD / Factur-X PDF)."
    }
  },
  "type": "object",
  "required": [
    "model",
    "detection",
    "source"
  ],
  "$defs": {
    "ParseDetection": {
      "properties": {
        "syntax": {
          "type": "string",
          "title": "Syntax",
          "description": "Syntax of the source document: 'ubl' or 'cii'."
        },
        "flavor": {
          "type": "string",
          "title": "Flavor",
          "description": "Rule set of the source, read from its CustomizationID: 'xrechnung', 'peppol_bis', 'factur_x', 'en16931' or 'unknown'."
        },
        "customization_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Customization Id",
          "description": "The CustomizationID (specification identifier, BT-24) of the source, if any."
        }
      },
      "type": "object",
      "required": [
        "syntax",
        "flavor",
        "customization_id"
      ],
      "title": "ParseDetection",
      "description": "What invowerk detected about the source document, from its bytes."
    }
  }
}