node-zugferd
IntroductionInstallation

ZUGFeRD

Minimum
Basic WL
Basic
EN 16931
Extended
XRechnung

Order-X

Basic
Comfort

XRechnung

This profile has been included specifically to include invoices for Germany. The validity of the structure is based on and is under the sole responsibility of KoSIT, Germany's central coordination agency for IT's e-invoice CIUS "XRechnung". It is defined as the standard for electronic invoices issued to public administrations and may include specific business rules to EN 16931 in order to comply with national laws and regulations.

Basic Usage

Install the Profile

npm install @node-zugferd/xrechnung@beta

Setup the Profile

Register the profile when creating your zugferd instance:

lib/invoicer.ts
import { xrechnung } from "@node-zugferd/xrechnung";
import { zugferd } from "node-zugferd";

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

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.Xrechnung = {
  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("xrechnung", data);

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

Schema

  • BG-0

    Invoice

    1..1


 

llms.txt
Extended

Basic

Edit on GitHubPrivacyImprint

On this page

Basic UsageInstall the ProfileSetup the ProfileDefine Invoice DataGenerate InvoiceSchema

How is this guide?