Guide · Python
Generate a PDF invoice from JSON in Python
Your Python code sends the facts of an invoice (customer, lines, VAT rate) and gets back a finished PDF. Sums, number formats, the due date and the payment QR code are the template’s job, so none of that logic ends up in your application.
Free plan with 100 units a month, no credit card
What you need
- An API key. Create one in the app under API keys and export it as
FORMFEED_API_KEY. A test key (ff_test_…) is right for trying things out. See the quick start. - Python. You need Python 3.10 or newer and the
formfeedpackage (it bringshttpxandpydantic). - The template.
invoice-defrom the invoice example: copy it into your workspace from the example’s page, which keeps the nameinvoice-deand publishes the copy, or push the folder with the CLI (formfeed templates push --publish). A render uses the published version. - The data. The example’s
data.jsonnext to the program. It holds the company, the customer and two invoice lines, and no totals.
pip install formfeedThe program
The program reads data.json, posts it with the template’s name and a file name built from the invoice number, waits for the result when the API answers 202, stops with the API’s message when something is wrong, and saves the PDF.
import json
import os
from pathlib import Path
from formfeed import Formfeed
formfeed = Formfeed(api_key=os.environ["FORMFEED_API_KEY"])
data = json.loads(Path("data.json").read_text(encoding="utf-8"))
# a problem answer (4xx, 5xx) raises a FormfeedError with the API's code, title and detail
render = formfeed.renders.create(
template="invoice-de",
data=data,
filename=f"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 = formfeed.renders.wait_for(render.id)
if render.status == "failed":
raise SystemExit(f"render failed: {render.error}")
Path("invoice.pdf").write_bytes(formfeed.renders.download(render))
print(render.id, render.page_count, "page(s),", render.units, "unit(s)")Run it
It prints the render’s id, the page count and the units it cost, and invoice.pdf lies next to the program. With a key that starts with ff_test_ the render is not metered; on the Free plan it carries a small watermark.
export FORMFEED_API_KEY=ff_test_...
python render.pyWhat is particular about Python
- Keyword arguments. Every field of the request is a keyword argument (
renders.create,pdf.protect), after the items ofrenders.batchand the sources ofpdf.merge, which come first; nested options such assettingsorpostare plain dictionaries. - Retries are built in. The client sends an
Idempotency-Keywith every render and retries429,503and network errors up to three times with backoff, with the same key: a retry of a request that was answered already gets that answer back instead of a second render. - Typed results. The answer is a pydantic model:
render.download_url,render.page_countandrender.unitsare attributes, not dictionary keys. - Async too.
AsyncFormfeedhas the same methods as coroutines, for FastAPI or any asyncio service.
What the template does with the JSON
The request carries no derived numbers, which is the point of rendering from a template:
- Totals.
invoice.lines | sum('total')adds the lines, and VAT and gross follow frominvoice.vat_rate. - Formats. With the template’s locale
de-DE,moneyprints3.760,40 €anddate('dd.MM.yyyy')prints10.09.2026;dateAdd(14, 'days')sets the due date. - GiroCode.
epcQrdraws the SEPA payment code from name, IBAN, BIC, amount and reference. - File name. is not the template’s job. The API takes
filenameas written and fills in no template expressions, so the program buildsinvoice-2026-0042.pdffrom the invoice number, and the download carries that name. Characters outside A–Z, a–z, 0–9,.,-,_,(,)and the space become_.
From one invoice to many
An invoice run is a batch: one request with up to 1,000 documents, one zip at the end, and a webhook when it is done. See batches. For documents that take longer than a few seconds, render asynchronously and let a webhook report back.
When the API says no
- One shape for every error. Errors are problem documents (RFC 9457) with
type,title,status,detail, a stablecodeand therequest_idto quote to support; thetypeURL leads to a page about that error. The list is in the error reference. - The usual ones.
401 unauthorizedfor a missing or revoked key,404 template_not_foundfor a wrong template name,422 template_runtime_errorwhen the template fails on the data,429 rate_limitedabove the plan’s requests per second,402 quota_exceededwhen the Free plan’s units are used up (a paid plan bills extra units up to its hard cap). - Retry safely. Send an
Idempotency-Keyheader with the POST, and repeat the request with the same key when you do not know whether the first attempt arrived: for 24 hours the key returns the first answer instead of rendering and billing again. The answer is stored once the first attempt has been answered, so do not retry while it may still run; and problems below 500 are stored too, so a corrected request needs a new key.
The job around this program
This guide is one program. What the job needs around it, from the template to the limits and the price, is on the page Invoice PDF API.
More Python guides
FAQ
- Can I send the invoice HTML instead of using a stored template?
- Yes, put it in
htmland leavetemplateout; the HTML-to-PDF guide of this language shows it. A stored template adds versions, a preview with your sample data and release channels. - How long is the download URL valid?
- A signed link is valid for at most seven days and never longer than the file is kept, which your plan’s retention decides (a workspace setting or
expires_incan only shorten it).GET /renders/{id}issues a fresh link at any time, so store the render’s id, not the URL. Withaccess: "public"the link lasts as long as the file. Details in the rendering docs. - What does a render cost?
- One unit for every started five pages of a PDF, so one to five pages cost one unit and six to ten cost two. Test renders are free. See pricing.