api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "computed": {
          "description": "The totals (BG-22) and VAT breakdown (BG-23) actually serialized in the XML, restated for agent re-reading: computed from the lines when not provided, verified when provided. Amounts are exact decimal strings",
          "properties": {
            "totals": {
              "properties": {
                "due": {
                  "type": "string"
                },
                "grand_total": {
                  "type": "string"
                },
                "lines_net": {
                  "type": "string"
                },
                "net": {
                  "type": "string"
                },
                "vat_total": {
                  "type": "string"
                }
              },
              "required": [
                "due",
                "grand_total",
                "lines_net",
                "net",
                "vat_total"
              ],
              "type": "object"
            },
            "vat_breakdown": {
              "items": {
                "properties": {
                  "category": {
                    "type": "string"
                  },
                  "rate": {
                    "type": "string"
                  },
                  "tax_amount": {
                    "type": "string"
                  },
                  "taxable_amount": {
                    "type": "string"
                  }
                },
                "required": [
                  "category",
                  "rate",
                  "tax_amount",
                  "taxable_amount"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "required": [
            "totals",
            "vat_breakdown"
          ],
          "type": "object"
        },
        "profile": {
          "description": "Profile URN emitted in the XML's BT-24 for CII output: urn:cen.eu:en16931:2017 (Factur-X EN 16931) - the legal core of the French 2026-2027 reform. Null for UBL output (the Factur-X profile is a CII notion; the UBL CustomizationID carries the bare EN 16931 identifier, or the Peppol BIS Billing 3.0 customization when ruleset=peppol). The response also echoes syntax ('ubl' only, omitted for the CII default) and ruleset ('peppol' only). PDF/A-3 (Factur-X envelope) is the dedicated /invoice/generate-pdf endpoint",
          "type": [
            "string",
            "null"
          ]
        },
        "ruleset": {
          "type": "string"
        },
        "syntax": {
          "type": "string"
        },
        "validated": {
          "description": "Post-condition echo: always true on a 200 (generated-then-validated guarantee)",
          "type": "boolean"
        },
        "vat_treatment": {
          "type": "object"
        },
        "warnings": {
          "type": "array"
        },
        "xml": {
          "description": "The complete generated CII D16B XML, guaranteed conformant: before being served it is re-parsed and re-validated by the service's own EN 16931 engine (the four layers of /invoice/validate: XSD, business rules BR-xx, Factur-X profile, identifier plausibility). A generation that would fail its own validation is a 500 - never served, never charged",
          "type": "string"
        }
      },
      "required": [
        "computed",
        "profile",
        "validated",
        "xml"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}