PDF-Rechnung aus JSON erzeugen mit Node.js (TypeScript)

Was Sie brauchen

• Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
• Node.js (TypeScript). Sie brauchen Node.js 22 oder neuer und das Paket @formfeed/sdk, das selbst keine Abhängigkeiten hat.
• Die Vorlage. invoice-de aus dem Rechnungsbeispiel: Kopieren Sie es von der Seite des Beispiels in Ihren Workspace; die Kopie behält den Namen invoice-de und ist veröffentlicht. Oder pushen Sie den Ordner mit der CLI (formfeed templates push --publish). Ein Rendering nutzt die veröffentlichte Version.
• Die Daten. Die data.json des Beispiels neben dem Programm. Sie enthält Firma, Kunde und zwei Positionen, aber keine Summen.

npm install @formfeed/sdk
npm install --save-dev tsx   # führt die .ts-Datei direkt aus

Das Programm

Das Programm liest data.json, sendet sie mit dem Namen der Vorlage und einem Dateinamen aus der Rechnungsnummer, wartet auf das Ergebnis, wenn die API mit 202 antwortet, bricht mit der Meldung der API ab, wenn etwas nicht stimmt, und speichert das PDF.

import { readFile, writeFile } from 'node:fs/promises';
import { Formfeed } from '@formfeed/sdk';

const formfeed = new Formfeed({ apiKey: process.env.FORMFEED_API_KEY! });
const data = JSON.parse(await readFile('data.json', 'utf8'));

// a problem answer (4xx, 5xx) throws a FormfeedError with the API's code, title and detail
let render = await formfeed.renders.create({
  template: 'invoice-de',
  data,
  filename: `invoice-${data.invoice.number}.pdf`,
});
// not done within 60 seconds: the API answered 202 and the render goes on in the background
if (render.status !== 'succeeded') render = await formfeed.renders.waitFor(render.id);
if (render.status === 'failed') throw new Error(`render failed: ${JSON.stringify(render.error)}`);

await writeFile('invoice.pdf', await formfeed.renders.download(render));
console.log(render.id, render.page_count, 'page(s),', render.units, 'unit(s)');

Ausführen

Es gibt die ID des Renderings, die Seitenzahl und die verbrauchten Einheiten aus, und invoice.pdf liegt neben dem Programm. Mit einem Schlüssel, der mit ff_test_ beginnt, wird das Rendering nicht gezählt; im Free-Tarif trägt es ein kleines Wasserzeichen.

export FORMFEED_API_KEY=ff_test_...
npx tsx render.ts

Was an Node.js (TypeScript) besonders ist

• Top-Level-await. Die Datei verwendet await außerhalb einer Funktion, sie muss also ein ES-Modul sein: "type": "module" in der package.json oder die Endung .mts.
• Retries sind eingebaut. Das SDK sendet mit jedem Rendering einen Idempotency-Key und wiederholt 429, 503 und Netzwerkfehler bis zu dreimal mit Backoff, mit demselben Schlüssel: Ein Retry einer Anfrage, die schon beantwortet wurde, erhält diese Antwort zurück statt eines zweiten Renderings.
• Typisierte Fehler. Eine Problem-Antwort wirft einen FormfeedError, dessen code der Fehlercode der API ist (template_not_found, quota_exceeded, …); fangen Sie ihn dort, wo Sie dem Nutzer etwas Sinnvolles zeigen können.
• Läuft überall, wo es fetch gibt. Das SDK nutzt nur Web-APIs, derselbe Aufruf funktioniert also in Deno, Bun und Cloudflare Workers; nur der Dateizugriff ist anders.

Was die Vorlage mit dem JSON macht

Die Anfrage enthält keine abgeleiteten Zahlen, und genau das ist der Sinn des Renderns aus einer Vorlage:

• Summen. invoice.lines | sum('total') addiert die Positionen, Umsatzsteuer und Brutto ergeben sich aus invoice.vat_rate.
• Formate. Mit der Locale de-DE der Vorlage gibt money 3.760,40 € aus und date('dd.MM.yyyy') 10.09.2026; dateAdd(14, 'days') setzt die Fälligkeit.
• GiroCode. epcQr zeichnet den SEPA-Zahlungscode aus Name, IBAN, BIC, Betrag und Verwendungszweck.
• Dateiname. ist nicht Sache der Vorlage. Die API übernimmt filename, wie er ist, und füllt keine Vorlagen-Ausdrücke, deshalb baut das Programm invoice-2026-0042.pdf aus der Rechnungsnummer, und der Download trägt diesen Namen. Zeichen außer A–Z, a–z, 0–9, ., -, _, (, ) und dem Leerzeichen werden zu _, Umlaute also auch.

Von einer Rechnung zu vielen

Ein Rechnungslauf ist ein Batch: eine Anfrage mit bis zu 1.000 Dokumenten, am Ende ein Zip und ein Webhook, wenn alles fertig ist. Siehe Batches. Dokumente, die länger als ein paar Sekunden brauchen, rendern Sie asynchron und lassen sich per Webhook benachrichtigen.

Wenn die API nein sagt

• Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
• Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
• Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Rechnungs-PDF-API.

Weitere Guides für Node.js (TypeScript)

• ZUGFeRD-E-Rechnung erstellen mit Node.js (TypeScript)
• HTML in PDF umwandeln mit Node.js (TypeScript)
• Open-Graph-Bilder erzeugen mit Node.js (TypeScript)
• PDFs aus einer CSV erzeugen mit Node.js (TypeScript)
• PDFs zusammenfügen und mit Passwort schützen mit Node.js (TypeScript)
• PDF asynchron rendern und den Webhook prüfen mit Node.js (TypeScript)

FAQ

Kann ich das Rechnungs-HTML senden, statt eine gespeicherte Vorlage zu nutzen?

Ja, setzen Sie es in html und lassen Sie template weg; der HTML-zu-PDF-Guide dieser Sprache zeigt es. Eine gespeicherte Vorlage bringt Versionen, eine Vorschau mit Ihren Beispieldaten und Release Channels.

Wie lange gilt die Download-URL?

Ein signierter Link gilt höchstens sieben Tage und nie länger, als die Datei aufbewahrt wird; darüber entscheidet die Aufbewahrung Ihres Tarifs (eine Einstellung des Workspace oder expires_in kann sie nur verkürzen). GET /renders/{id} stellt jederzeit einen frischen Link aus, speichern Sie also die ID des Renderings, nicht die URL. Mit access: "public" gilt der Link so lange wie die Datei. Details in der Rendering-Doku.

Was kostet ein Rendering?

Eine Einheit je angefangene fünf Seiten eines PDFs, also eine für eine bis fünf Seiten und zwei für sechs bis zehn. Test-Renderings sind kostenlos. Siehe Preise.

PDF-Rechnung aus JSON in anderen Sprachen

• Python
• PHP
• Go
• C# (.NET)
• Java
• Ruby
• curl