Skip to main content
Introducing packages.sweber.dev
Documentation menuCLI

CLI

Validate invoices from the command line or in CI, extract XML from PDFs and check Leitweg-IDs.

npx @sweberdev/summand validate invoices/*.xml invoices/*.pdf
valid   invoices/RE-1001.xml  XRechnung 3.0  0 error(s), 0 warning(s)
INVALID invoices/RE-1002.pdf  EN 16931 (PDF)  1 error(s), 2 warning(s)
  error   BR-CO-15 (line 214): Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).

The exit code is 1 when at least one invoice is invalid and 2 when the command could not run (for example a file that does not exist), so it can guard a CI step or a script. All exit codes are listed below.

Commands

CommandDoes
summand validate <files...>Validate XML and PDF files
summand extract <file.pdf> [--out file.xml]Write the embedded XML of a ZUGFeRD / Factur-X PDF
summand leitweg <id>Check a Leitweg-ID and print the correct check digits
summand --versionPrint the version
summand rules [--json] [--check [--fail-on-outdated]]List the bundled rule sets with version, source, licence and rule count; --check asks whether newer releases exist (exit code 3 with --fail-on-outdated). Lists every bundled version, including older ones you can select. See Rule sets and versions.

validate options

OptionEffect
--jsonOne JSON result per line (JSON Lines)
--rule-sets <list>Rule sets to apply, comma-separated, each optionally with a version: en16931,xrechnung@2.5.0. Default auto. An unknown name or version is a usage error (exit 2). See Rule sets and versions.
--strict-extendedEXTENDED: EN 16931 violations are errors
--no-schemaSkip the XML Schema (XSD) check
--no-leitwegDo not check the Leitweg-ID in the buyer reference
--lang deMessages and output in German (default en)
--warnings-as-errorsExit 1 on warnings too
--quietOnly the summary line per file

Exit codes

CodeMeaning
0Success: every invoice is valid
1An invoice is invalid (or has warnings with --warnings-as-errors), including input that is not an invoice at all
2The command could not run: unknown command or flag, missing arguments, unreadable file
3rules --check --fail-on-outdated: a newer release of a bundled rule set exists

The codes follow ESLint: 1 is a finding, 2 is an error running the command. If one of several files cannot be read, the others are still validated and the exit code is 2. To tell an invalid invoice from a failed run in a script, test for 1 and 2 separately. Details: Error codes.

JSON output

--json prints one line per file: { "file": "invoice.xml", ...result }, where result is the ValidationResult. The field names are stable.

In code

import { runCli } from "@sweberdev/summand/cli";
const code = await runCli(["validate", "invoice.xml"]);