rechnungsapi-sdk

rechnungsapi-sdk

Official TypeScript/JavaScript SDK for RechnungsAPI — create, validate, and analyze ZUGFeRD (PDF/A-3) and X-Invoice (XRechnung/UBL) e-invoices.

Install

npm install rechnungsapi-sdk

Get an API token

Every request needs your own Bearer token — there's no shared or default token.

1. Sign in to the dashboard at rechnungsapi.de (sign up if you don't have an account yet).
2. Open your Profile page and copy the API token at the bottom.
3. Store it as an environment variable — never hardcode it or commit it to source control:

   # .env
   RECHNUNGSAPI_TOKEN=your-token-here

Usage

import { RechnungsApiClient } from "rechnungsapi-sdk"

const client = new RechnungsApiClient({ apiToken: process.env.RECHNUNGSAPI_TOKEN! })

// Create a ZUGFeRD PDF from structured invoice JSON
const result = await client.createZugferdFromJson(
  { invoiceNumber: "RE-2026-001", /* ... */ },
  invoicePdfBase64,
)

// Validate an X-Invoice XML document
const validation = await client.validateXInvoiceXml(xmlString)
if (!validation.isValid) {
  console.log(validation.messages)
}

// Extract structured JSON from a scanned/PDF invoice
const extracted = await client.analyzePdfInvoiceV2(pdfBase64, /* withLineItems */ true)

By default the client talks to the production gateway. To test against a sandbox instead (if your account has one), pass baseUrl:

const client = new RechnungsApiClient({
  apiToken: process.env.RECHNUNGSAPI_TOKEN!,
  baseUrl: "https://sandbox.rechnungsapi.de",
})

API

Errors are thrown as RechnungsApiError (with .status and .body), or ValidationFailedError for HTTP 412 responses (missing mandatory invoice fields).

Development

yarn install
yarn test
yarn build

License

MIT