node-zugferd
IntroductionInstallation

ZUGFeRD

Minimum
Basic WL
Basic
EN 16931
Extended
XRechnung

Order-X

Basic
Comfort

EN 16931

This profile includes BASIC, with all the additional data required by the European Semantics Standard, whether optional or conditional. It is fully compliant to EN 16931, focussing on the core elements of an electronic invoice.

Basic Usage

Install the Profile

npm install @node-zugferd/en-16931@beta

Setup the Profile

Register the profile when creating your zugferd instance:

lib/invoicer.ts
import { en16931 } from "@node-zugferd/en-16931";
import { zugferd } from "node-zugferd";

export const invoicer = zugferd({
  profiles: [en16931], 
});

Define Invoice Data

Provide invoice data that satisfies the requirements of this profile.

data.ts
import type { invoicer } from "@/lib/invoicer";

const data: typeof invoicer.$Infer.Input.En16931 = {
  exchangedDocument: {
    invoiceNumber: "471102",
    // ...
  },
  // ...
};

Generate Invoice

Create the invoice and embed it into a PDF/A document or serialize it for further processing.

invoice.ts
import { invoicer } from "@/lib/invoicer";
import { data } from "./data";
import { readFile } from "node:fs/promises";

const invoice = await invoicer.create("en-16931", data);

const xml = invoice.toXML();
const pdfA = await invoice.toPDF(
  await readFile("./my-invoice.pdf"),
);

Schema

  • BG-0

    Invoice

    1..1


 

llms.txt
Basic

Extended

Edit on GitHubPrivacyImprint

On this page

Basic UsageInstall the ProfileSetup the ProfileDefine Invoice DataGenerate InvoiceSchema

How is this guide?