Zum Inhalt springen

ZUGFeRD- und Factur-X-API

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.

POST /api/v1/convert

curl + jq
curl -sS https://klarbon.app/api/v1/convert \
  -H "Authorization: Bearer $KLARBON_API_KEY" \
  -H "Idempotency-Key: invoice-123456XX-zugferd" \
  -F "file=@invoice.xml;type=application/xml" \
  -F target=zugferd \
  -o result.json
jq -e '.ok' result.json > /dev/null || { jq -r '.error + ": " + .message' result.json; exit 1; }
jq -r '.file.content' result.json | base64 --decode > "$(jq -r '.file.filename' result.json)"
TypeScript, Node.js 22.18+
import { readFile, writeFile } from "node:fs/promises"

type KlarbonFile = { content: string; filename: string; mime: string; bytes: number }
type Failure = { ok: false; error: string; message: string }
type Converted = { ok: true; file: KlarbonFile; credits: { spent: number; balance: number } }

const form = new FormData()
form.append("file", new Blob([await readFile("invoice.xml")], { type: "application/xml" }), "invoice.xml")
form.append("target", "zugferd")

const response = await fetch("https://klarbon.app/api/v1/convert", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KLARBON_API_KEY}`,
    "Idempotency-Key": "invoice-123456XX-zugferd",
  },
  body: form,
})
const result = (await response.json()) as Converted | Failure
if (!result.ok) throw new Error(`${response.status} ${result.error}: ${result.message}`)
await writeFile(result.file.filename, Buffer.from(result.file.content, "base64"))
console.log(`${result.file.filename} written, ${result.credits.balance} credits left`)
Python 3.9+, requests
import base64
import os

import requests

with open("invoice.xml", "rb") as upload:
    response = requests.post(
        "https://klarbon.app/api/v1/convert",
        headers={
            "Authorization": f"Bearer {os.environ['KLARBON_API_KEY']}",
            "Idempotency-Key": "invoice-123456XX-zugferd",
        },
        files={"file": ("invoice.xml", upload, "application/xml")},
        data={"target": "zugferd"},
        timeout=120,
    )
result = response.json()
if not result["ok"]:
    raise SystemExit(f"{response.status_code} {result['error']}: {result['message']}")
with open(result["file"]["filename"], "wb") as output:
    output.write(base64.b64decode(result["file"]["content"]))
print(result["file"]["filename"], "written,", result["credits"]["balance"], "credits left")
PHP 8+, curl
<?php
$curl = curl_init('https://klarbon.app/api/v1/convert');
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 120,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('KLARBON_API_KEY'),
        'Idempotency-Key: invoice-123456XX-zugferd',
    ],
    CURLOPT_POSTFIELDS => [
        'file' => new CURLFile('invoice.xml', 'application/xml', 'invoice.xml'),
        'target' => 'zugferd',
    ],
]);
$body = curl_exec($curl);
if ($body === false) {
    fwrite(STDERR, curl_error($curl) . "\n");
    exit(1);
}
$result = json_decode($body, true);
if (!$result['ok']) {
    $status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
    fwrite(STDERR, "$status {$result['error']}: {$result['message']}\n");
    exit(1);
}
file_put_contents($result['file']['filename'], base64_decode($result['file']['content']));
echo "{$result['file']['filename']} written, {$result['credits']['balance']} credits left\n";
C#, .NET 10
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.

Für die Seite gekürzt: file.content: base64 cut

{
  "ok": true,
  "file": {
    "content": "JVBERi0xLjcKJfbk/N8KMjggMCBvYmoKPDwKL1R5cGUgL0Nh...",
    "filename": "123456XX-zugferd.pdf",
    "mime": "application/pdf",
    "bytes": 32690
  },
  "report": {
    "detected": {
      "syntax": "cii",
      "customizationId": "urn:cen.eu:en16931:2017",
      "profile": "en16931",
      "container": "pdf"
    },
    "ruleset": {
      "id": "facturx-1.09-en16931",
      "name": "Factur-X en16931",
      "version": "1.0.9-2"
    },
    "valid": true,
    "pdf": {
      "pdfa": {
        "conforms": true,
        "part": 3,
        "conformance": "B",
        "findings": []
      },
      "xmlFilename": "factur-x.xml",
      "profile": "en16931"
    },
    "engineVersion": "1.0.0",
    "durationMs": 208,
    "findings": [
      {
        "ruleId": "PEPPOL-EN16931-R008",
        "severity": "warning",
        "message": "[PEPPOL-EN16931-R008]-Document MUST not contain empty elements. (still status warning)",
        "location": "/rsm:CrossIndustryInvoice[1]/rsm:SupplyChainTradeTransaction[1]/ram:ApplicableHeaderTradeDelivery[1]",
        "test": "false",
        "title": "PEPPOL-EN16931-R008",
        "what": "[PEPPOL-EN16931-R008]-Document MUST not contain empty elements. (still status warning)",
        "fix": "",
        "link": null,
        "officialUrl": null
      }
    ]
  },
  "losses": [
    {
      "kind": "changed",
      "path": "specificationId"
    }
  ],
  "credits": {
    "spent": 1,
    "balance": 199,
    "plan": 0,
    "bought": 199
  }
}

Kosten

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.

Weiter

Die Entwicklerdokumentation ist auf Englisch.

Häufige Fragen

Sind ZUGFeRD und Factur-X dieselbe Datei?

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.

Quellen

Aktualisiert am 6. November 2026