Skip to content

generate

Generates a Factur-X PDF.

Usage

facturx generate [options]

Options

  • --pdf <path> (required)
    The path to the PDF that will be used as base.
    Type: string

  • --cii <path> (required)
    The path to the CII file to use as structured data.
    Type: string

  • --cii-name <name>
    The name of the CII attachment in the result.
    Type: string
    Default: factur-x.xml

  • --attach <path>
    Additional files to attach to the result.
    Type: string

  • --author <name>
    The name of the author of the document. This will be added to the metadata of the output file.
    Type: string

  • --output-path <path>
    The path to the output file.
    Aliases: -o
    Type: string

  • --skip-validation
    Do not validate the generated Factur-X PDF.
    Type: true | false
    Default: false

  • --warnings-as-errors
    Treat warnings as errors.
    Type: true | false
    Default: false

  • --profile
    The profile to use for validation. If set, the profile will override the one specified in the Factur-X file.
    Aliases: -p
    Type: none | minimum | basicwl | basic | en16931 | extended

  • --skip-rule
    The business rules that should be skipped. Example: --skip-rule "BR-1" --skip-rule "BR-2"
    Aliases: -s
    Type: string

  • --verbosity
    Set the verbosity level.
    Aliases: -v
    Type: quiet | minimal | normal | detailed | diagnostic
    Default: normal

The tools are open source and released under the MIT License, feel free to use, modify, and share.