Service

Health and the configured rule sets.

Supported formats, profiles and rule-set versions

GET

https://einvoice-api-main-f5141d8.zuplo.app

/v1/formats

Supported formats, profiles and rule-set versions.

Supported formats, profiles and rule-set versions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Supported formats, profiles and rule-set versions › Responses

Configured rule packs and the documents (specification identifiers) each validates.

Formats

object[] · required

GET/v1/formats

curl https://einvoice-api-main-f5141d8.zuplo.app/v1/formats \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "rulesets": [
    {
      "id": "xrechnung",
      "version": "3.0.2",
      "release": "2026-08-31",
      "default": true,
      "status": "current",
      "pin": "xrechnung@3.0.2",
      "description": "KoSIT validator configuration for XRechnung 3.0.2 (CEN EN 16931 Schematron 1.3.16, XRechnung Schematron 2.6.0)",
      "documents": [
        {
          "guidelineId": "urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0",
          "profile": "XRECHNUNG",
          "format": "xrechnung",
          "syntaxes": [
            "CII",
            "UBL"
          ],
          "containers": [
            "XML",
            "PDF"
          ],
          "en16931Invoice": true
        }
      ]
    },
    {
      "id": "zugferd",
      "version": "2.5.2",
      "release": "mustang-2.26.0",
      "default": true,
      "status": "current",
      "pin": "zugferd@2.5.2",
      "documents": [
        {
          "guidelineId": "urn:factur-x.eu:1p0:minimum",
          "profile": "MINIMUM",
          "format": "zugferd",
          "syntaxes": [
            "CII"
          ],
          "containers": [
            "XML",
            "PDF"
          ],
          "en16931Invoice": false
        }
      ]
    },
    {
      "id": "xrechnung",
      "version": "3.0.3",
      "release": "2027-01-31",
      "default": false,
      "status": "preview",
      "effectiveFrom": "2027-08-01",
      "pin": "xrechnung@3.0.3",
      "description": "Upcoming XRechnung release (illustration; used by POST /v1/preview/validate)",
      "documents": [
        {
          "guidelineId": "urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0",
          "profile": "XRECHNUNG",
          "format": "xrechnung",
          "syntaxes": [
            "CII",
            "UBL"
          ],
          "containers": [
            "XML",
            "PDF"
          ],
          "en16931Invoice": true
        }
      ]
    }
  ]
}

json

application/json

Liveness and loaded rule sets

GET

https://einvoice-api-main-f5141d8.zuplo.app

/v1/health

Liveness and loaded rule sets.

Liveness and loaded rule sets › Responses

The service is up and all rule packs are compiled.

Health

status

string · enum · required

Enum values:

version

string · required

object[] · required

Documents