Documentation menuDocumentation
Summand documentation
Validate XRechnung, ZUGFeRD and Factur-X e-invoices against EN 16931 in pure TypeScript: in Node, the browser and at the edge, without Java.
Try the live demoStart
Guides
- Validating invoicesvalidateInvoice in detail - input types, options, the result object and how to show errors to people.
- Profiles and rule setsWhich rules Summand applies for XRechnung, ZUGFeRD, Factur-X and Peppol invoices.
- XML SchemaHow Summand checks invoices against the UBL 2.1 and UN/CEFACT CII D16B XML Schemas before the Schematron rules, what it reports and what it does not check.
- Rule sets and versionsSelect rule sets and bundled versions with the ruleSets option, see which versions are bundled, count their rules and check whether newer releases exist.
- Validating many invoicesvalidateMany validates folders and archives of invoices with a bounded pool of worker threads in Node.js - streaming results in input order, errors per file, measured speed-up.
- Performance on large invoicesHow long validation takes for invoices with 100, 1,000 and 5,000 lines, how it was measured and what changed.
- ZUGFeRD and Factur-X PDFsHow Summand finds the invoice XML in a hybrid PDF and what it checks about the PDF.
- In the browserValidate uploads on the client before they reach your server, without sending invoices anywhere.
- CLIValidate invoices from the command line or in CI, extract XML from PDFs and check Leitweg-IDs.
- Leitweg-IDCheck the routing identifier German public buyers require in XRechnung invoices.
- Schematron and XPathUse Summand's XPath 2.0 and Schematron engine for your own rules, e.g. company-specific invoice checks.
Pro
Reference
- APIAll exports of @sweberdev/summand, @sweberdev/summand/xpath, @sweberdev/summand/rules-check, @sweberdev/summand/batch and @sweberdev/summand/cli, with their stability.
- Error codesEvery SUM- code Summand reports, with severity, meaning, cause and fix, plus the exit codes of the summand command.
- Rule setsThe bundled official rule sets and XML Schemas, their versions, sources and licences.