Skip to content

Validate and convert

This guide describes how to validate documents (check format and business rules) and convert between formats (e.g. to XRechnung or Peppol BIS) using the Format API.

Why validate

  • Check XML or model before creating a document — avoid failed status after upload.
  • Get a structured report with errors and warnings (e.g. missing required field, invalid code).

Why convert

  • Produce a target format (e.g. XRechnung UBL, Peppol BIS) from another format or from the model (JSON).
  • Use the result as input for upload or for sending (e.g. convert to Peppol BIS then upload and send via Peppol).

Web

  • Validation: In the web app, use Tools (or the relevant section) → Validation — upload XML or paste content, choose format if needed, run validation. The report shows errors and warnings.
  • Convert: If the interface offers conversion, select source (file or model), choose target format, and download or use the result.

Exact menu names may depend on your deployment; see Platform overview.

API

  • Validate: Call the format validation endpoint (e.g. validate XML or validate model). Send the document body (XML or JSON) and optionally the format code. Response: validation result and list of issues.
  • Convert/transform: Call the transform endpoint: send source document (XML or model) and target format; response is the converted document (e.g. XML or model).

Base path for format endpoints is usually under /api/v2/formats/ (e.g. validate, transform). See API reference for exact paths and parameters.

Next steps