html – Rechnung als Webseite darstellen

REST-API · POST /visualize/html · kostenpflichtig

Rechnung als Webseite: lesbar für Menschen, direkt aus der API.

Diese Route macht aus einer E-Rechnung eine lesbare Webseite. Eine XML-Rechnung ist für Menschen kaum zu lesen; die Darstellung zeigt Absender, Empfänger, Positionen, Steuern und Zahlungsangaben so, wie man es von einer Rechnung auf Papier kennt.

Die Darstellung entsteht mit dem Visualisierungsteil des KoSIT-Validators. Sie eignet sich zum Anzeigen in Ihrem eigenen Programm oder im Browser.

Zur API-Übersicht

Im Browser ausprobieren

Anfrage

So rufen Sie die Route auf

Adresse: POST https://invoicepress.de/wp-json/einvoice-api/v1/visualize/html

Schlüssel: Senden Sie Ihren API-Schlüssel in der Kopfzeile Authorization: Bearer <Schlüssel> oder in X-Api-Key. Beide Schreibweisen gelten gleich. Ohne Schlüssel gilt das freie Kontingent von zwei Aufrufen je Route und Tag; ein gesendeter, aber ungültiger Schlüssel bekommt den Status 401.

Inhalt: Der Inhalt der Anfrage ist die Rechnung selbst: als XML (XRechnung, Peppol BIS, CII oder UBL) mit Content-Type: application/xml oder als ZUGFeRD- beziehungsweise Factur-X-PDF mit Content-Type: application/pdf. Aus einer PDF holt der Dienst zuerst die eingebettete Rechnung.

Parameter

lang (wahlweise) – de oder en: die Sprache der Beschriftungen.

Diese Route reicht die Rechnung an die Validator Bridge auf unserem Server weiter. Die Bridge ist ein kleines Programm, das dort den Validator betreibt. Die Rechnung geht an diese Bridge und an keinen anderen Dienst.

Die Rechnung wird nur im Arbeitsspeicher verarbeitet und nicht gespeichert. Im Nutzungsprotokoll steht nur ein Fingerabdruck der Anfrage, nie ihr Inhalt.

Antwort

Was zurückkommt

Status 200 – mit der Darstellung als Webseite (text/html).

Wenn etwas nicht geht

Status 401 – Es wurde ein Schlüssel gesendet, aber er ist nicht gültig.

Status 403 – Die Route ist auf diesem Dienst abgeschaltet.

Status 429 – Das Kontingent ist verbraucht.

Status 501 – Auf diesem Dienst ist keine Validator Bridge eingerichtet.

Status 502 – Die Validator Bridge antwortet nicht.

Beispiel

Ein Aufruf mit curl

curl -X POST "https://invoicepress.de/wp-json/einvoice-api/v1/visualize/html?lang=de" \
     -H "X-Api-Key: <Schlüssel>" \
     -H "Content-Type: application/xml" \
     --data-binary @rechnung.xml -o rechnung.html

Kosten

Kontingent und Tarif

Die Route ist kostenpflichtig. Mit Schlüssel zählt jeder erfolgreiche Aufruf als eine Prüfung gegen das Monatskontingent Ihres Tarifs; Antworten mit einem Fehlerstatus zählen nicht. Zum Ausprobieren können Sie die Route ohne Schlüssel zweimal am Tag aufrufen. Diese Grenze gilt je Netzadresse und je Route: Zwei Aufrufe dieser Route lassen die übrigen Routen unberührt. Jede Antwort ohne Schlüssel sagt Ihnen in den Kopfzeilen X-RateLimit-Remaining und X-RateLimit-Reset, wie viele Aufrufe heute noch gehen und wann der Zähler zurückgesetzt wird.

Tarife und Schlüssel