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).

Web

  • Validierung: In der Web-App unter Tools (oder dem entsprechenden Bereich) → Validierung — XML hochladen oder Inhalt einfügen, Format ggf. wählen, Validierung starten. Der Bericht zeigt Fehler und Warnungen.
  • Konvertierung: Falls die Oberfläche Konvertierung anbietet: Quelle (Datei oder Modell) wählen, Zielformat wählen, Ergebnis herunterladen oder nutzen.

Die genauen Menübezeichnungen können je nach Installation variieren; siehe Plattform-Übersicht.

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