Zum Inhalt

Validieren und konvertieren

Diese Anleitung beschreibt, wie Sie Dokumente validieren (Format- und Geschäftsregeln prüfen) und zwischen Formaten konvertieren (z. B. nach XRechnung oder Peppol BIS) — mit der Format-API.

Warum validieren

  • XML oder Modell vor dem Anlegen eines Dokuments prüfen — vermeidet fehlgeschlagenen Status nach dem Upload.
  • Strukturierten Bericht mit Fehlern und Warnungen erhalten (z. B. fehlendes Pflichtfeld, ungültiger Code).

Warum konvertieren

  • Zielformat (z. B. XRechnung UBL, Peppol BIS) aus einem anderen Format oder aus dem Modell (JSON) erzeugen.
  • Ergebnis als Eingabe für Upload oder Versand nutzen (z. B. in Peppol BIS konvertieren, dann hochladen und per Peppol versenden).

Konvertierungen zwischen unterstützten Formaten laufen über den zentralen Hub xtool.canonical.1_0 (Quelle → Canonical → Ziel). Die typisierten xTool-Formate xtool.invoice.1_0 und xtool.credit_note.1_0 bleiben verfügbar; siehe Formate.

Web

  • Validierung: Werkzeuge → Validierung — XML-Datei hochladen (unter 10 MB), Format wählen oder automatisch erkennen, Validierung starten. Der Bericht zeigt XSD- und XSLT- (oder CSV-) Fehler und Warnungen mit Stellen. Siehe Werkzeuge-Oberfläche.
  • Vorhandenes Dokument konvertieren: Dokument öffnen → Formatkonvertierung. Zielformat wählen. Diese Aktion sehen Benutzer mit Recht zum Löschen von Dokumenten (gleiche Regel wie in PDF hochladen).
  • PDF aktualisieren: Am Dokument PDF aktualisieren ersetzt die Visualisierungs-PDF.

Siehe Dokumente-Oberfläche und Web-Überblick.

API

  • Validieren: Format-Validierungs-Endpoint aufrufen (z. B. XML oder Modell validieren). Dokument-Body (XML oder JSON) und optional Formatcode senden. Antwort: Validierungsergebnis und Liste der Meldungen.
  • Konvertieren/Transform: Transform-Endpoint aufrufen: Quelldokument (XML oder Modell) und Zielformat senden; Antwort ist das konvertierte Dokument (z. B. XML oder Modell).

Der Basispfad für Format-Endpoints liegt in der Regel unter /api/v2/formats/ (z. B. validate, transform). Siehe API-Referenz für exakte Pfade und Parameter.

Nächste Schritte