Aus XRechnung, UBL oder CII per API eine ZUGFeRD- oder Factur-X-PDF/A-3 erzeugen. Berechnet wird nur, wenn die Datei die Prüfungen besteht.
Diese Funktion ist in der Beta: Sie funktioniert und ist getestet, Details können sich noch ändern.
Auf dieser Seite
Die ZUGFeRD- und Factur-X-API von Klarbon macht aus einer XRechnung, UBL- oder CII-Rechnung ein hybrides PDF/A-3: eine lesbare Rechnung mit den strukturierten CII-Daten darin. Ein REST-Aufruf liefert das PDF und den Prüfbericht. Berechnet wird nur, wenn die Rechnungsregeln und eine unabhängige PDF/A-Prüfung bestanden sind. Die Dateien werden für die Anfrage verarbeitet, ohne Dokumentenarchiv.
Was die API macht
POST /api/v1/convert mit target=zugferd oder target=factur-x schreibt das PDF, im Profil EN 16931, wenn Sie kein anderes wählen.
POST /api/v1/make erzeugt dasselbe PDF aus Rechnungsdaten im JSON-Format.
Der Bericht nennt Regelwerk, Profil, den Namen der eingebetteten XML-Datei und das PDF/A-Ergebnis.
Was sie nicht macht
Das Schreiben von ZUGFeRD und Factur-X ist in der Beta: Es funktioniert und ist getestet, Details können sich noch ändern. Klarbon versendet keine Rechnungen. Für französische Rechnungen im Anwendungsbereich der Reform nutzen Sie eine zugelassene Plattform. Klären Sie, welches Format und welches Profil der Empfänger annimmt.
Schnellstart
Jedes Beispiel macht denselben Aufruf. Vor der Veröffentlichung läuft jedes einzelne gegen einen lokalen Klarbon-Server und die echte Validierung.
Legen Sie auf Ihrer Kontoseite einen Schlüssel an und setzen Sie ihn als KLARBON_API_KEY. Der Schlüssel gehört nie in die Adresse.
using System.Net.Http.Headers;
using System.Text.Json;
using var http = new HttpClient();
var key = Environment.GetEnvironmentVariable("KLARBON_API_KEY");
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", key);
var upload = new ByteArrayContent(await File.ReadAllBytesAsync("invoice.xml"));
upload.Headers.ContentType = new MediaTypeHeaderValue("application/xml");
using var request = new HttpRequestMessage(HttpMethod.Post, "https://klarbon.app/api/v1/convert?target=zugferd") { Content = upload };
request.Headers.Add("Idempotency-Key", "invoice-123456XX-zugferd");
using var response = await http.SendAsync(request);
using var json = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var result = json.RootElement;
if (!result.GetProperty("ok").GetBoolean())
{
Console.Error.WriteLine($"{(int)response.StatusCode} {result.GetProperty("error")}: {result.GetProperty("message")}");
return 1;
}
var written = result.GetProperty("file");
await File.WriteAllBytesAsync(written.GetProperty("filename").GetString()!,
Convert.FromBase64String(written.GetProperty("content").GetString()!));
Console.WriteLine($"{written.GetProperty("filename")} written, {result.GetProperty("credits").GetProperty("balance")} credits left");
return 0;
Die Antwort
Die Antwort auf den curl-Aufruf oben, aufgezeichnet bei diesem Lauf mit KoSIT XRechnung test suite, business case 01.01a (UBL), Apache-2.0.
Vorausbezahlte API-Pakete, per Karte auf Ihrer Kontoseite gekauft: 1.000 Aufrufe für 39,00 €, 5.000 Aufrufe für 129,00 €, 25.000 Aufrufe für 449,00 €, 100.000 Aufrufe für 990,00 €, ohne Ablaufdatum. Ihr erster Schlüssel bringt 25 kostenlose Aufrufe. Kostenpflichtige Aufrufe verbrauchen zuerst das API-Guthaben, danach dieselben Credits wie die Website. Ein fehlgeschlagener Aufruf kostet nichts.
Aufruf
Kosten
POST /open
Kostenlos, faire Nutzung bis 1.000 am Tag pro Konto
POST /check
Kostenlos im Tageslimit Ihres Tarifs (20 am Tag im kostenlosen Tarif)
POST /convert, POST /make
1 Aufruf, nur wenn die erzeugte Datei gültig ist
POST /bank/convert
1 Aufruf je angefangene 500 Umsätze, nur bei erfolgreicher Umwandlung
Grenzen
Dateien bis 20 MB, PDFs bis 50 Seiten.
60 Anfragen pro Minute je Schlüssel, 120 je Konto. Eine 429 enthält Retry-After.
Bis zu 10 Schlüssel pro Konto. Idempotency-Key gilt 24 Stunden, ein erneuter Versuch wird also nie doppelt berechnet.
Fehler
Jeder Fehler ist { ok: false, error, message }: ein fester Code und ein klarer Satz.
Status
Code
Wann
401
auth
Kein Schlüssel oder ein unbekannter oder widerrufener Schlüssel.
402
no_credits
API-Guthaben und Credits reichen beide nicht. Nichts wurde ausgeführt; topUpUrl nennt die Kaufseite.
413
too_large
Über 20 MB oder 50 PDF-Seiten.
415
unsupported
Ein Dateiformat, das die Route nicht annimmt.
422
invalid
Die Datei war nicht lesbar oder die erzeugte Datei ist nicht gültig. Nicht berechnet.
429
limit
Ein Ratenlimit oder die kostenlosen Aufrufe des Tages.
503
engine_unavailable
Die Validierung ist kurz nicht erreichbar. Nicht berechnet.
Datenschutz
Dateien werden für die Anfrage verarbeitet, ohne ein Dokumentenarchiv anzulegen. Die Anwendungsprotokolle von Klarbon enthalten weder Dateinamen noch Inhalte noch Schlüssel. Der vollständige Schlüssel wird nicht gespeichert, nur ein HMAC davon und ein kurzes Anzeigepräfix.
In den harmonisierten Versionen sind Factur-X und ZUGFeRD technisch identisch. Klarbon nutzt für beide Zielnamen denselben PDF-Schreiber. Fragen Sie den Empfänger, welche Version und welches Profil er annimmt.
Welches Profil schreibt die API?
Standardmäßig EN 16931. Über den Parameter profile wählen Sie ein anderes, sofern das Format es erlaubt. Der Bericht nennt das geschriebene Profil.
Wird das PDF als PDF/A-3 geprüft?
Ja. Ausgegeben wird nur eine Datei, deren fertiges PDF die Prüfung besteht. Sonst antwortet der Aufruf mit 422 und es wird nichts berechnet.
Kann ich direkt aus Rechnungsdaten eine Datei erstellen?
Ja. Die Route make nimmt Rechnungsdaten als JSON und liefert dasselbe geprüfte PDF.