node-zugferd
IntroductionInstallation

ZUGFeRD

Minimum
Basic WL
Basic
EN 16931
Extended
XRechnung

Order-X

Basic
Comfort

Basic

The Order-X BASIC profile has been built to addres a “standard” purchase order process, with no VAT information, except optionally on Totals, allowing single delivery or pick up mode in a single location with:

  • on Line level: Product description, Substituted Product for Order Response type message only, Line Note, Net Unit Price, Reference to Blanket Order line ID, potential partial delivery, requested quantity, and line total,
  • on Document level: Seller, Buyer, Ship From, Ship To Parties, with IDs, Name, Postal and electronic Addresses, Legal and VAT ID optionally (only for Seller and Buyer), Delivery terms, references to their business documents (Quotation, Contract, Blanket Order, Previous Order, Previous Order Change or previous Order Response), Requested delivery or pick-up date or period, Payment Terms, Totals and Buyer accounting reference.

Basic Usage

Install the Profile

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

Setup the Profile

Register the profile when creating your zugferd instance:

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

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

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.OrderXBasic = {
  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-basic", data);

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

Schema


 

llms.txt
XRechnung

Comfort

Edit on GitHubPrivacyImprint

On this page

Basic UsageInstall the ProfileSetup the ProfileDefine Order DataGenerate OrderSchema

How is this guide?