node-zugferd
IntroductionInstallation

ZUGFeRD

Minimum
Basic WL
Basic
EN 16931
Extended
XRechnung

Order-X

Basic
Comfort

Comfort

The COMFORT Profile is the BASIC profile with more information available optionally, allowing multiple delivery, Buyer Requisitioner Party, Invoicee Party, VAT information except VAT breakdown, Allowances and Charges on line and document levels and more details:

  • on Line level: item Characteristics, additional referenced product documents, line reference ID of Quotation and Catalog Reference Documents, Additional Referenced Documents, Gross Price and price discount, Allowances and Charges, Delivery or Pick-up Date or period for each item (allowing multiple delivery on the same location), VAT codes on line.
  • on Document level: with Buyer Requisitioner Party, Invoicee Party, Sales Order Reference (issued by the Seller), Tender or Lot Reference, Catalog Reference Document, Additional Referenced Documents, Ordered Object Identifier, Project Reference, Delivery Terms Location, Ship To and Ship From legal and VAT IDs, Payment means, Charges and Allowances on Document level with VAT codes.

Basic Usage

Install the Profile

npm install @node-zugferd/order-x@beta

Setup the Profile

Register the profile when creating your zugferd instance:

lib/invoicer.ts
import { orderX } from "@node-zugferd/order-x";
import { zugferd } from "node-zugferd";

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

Define Order Data

Provide order data that satisfies the requirements of this profile.

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

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

Generate Order

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

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

const order = await invoicer.create("order-x", data);

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

Schema


 

llms.txt
Basic

Parser

Read Factur-X and ZUGFeRD invoices from XML or PDF/A-3.

Edit on GitHubPrivacyImprint

On this page

Basic UsageInstall the ProfileSetup the ProfileDefine Order DataGenerate OrderSchema

How is this guide?