A tool for generating visualizations of invoices in PDF format based on XML invoice files downloaded from the National e-Invoice System (KSeF - Krajowy System e-Faktur) - https://ksef.podatki.gov.pl/.
The repository of this tool is based on a fork originating from:
- https://github.com/CIRFMF/ksef-pdf-generator (@CIRF)
- https://github.com/aiv/ksef-pdf-generator (@aiv (Mariusz Dalewski)
- https://github.com/niutech/ksef-pdf-generator (@niutech (niu tech)
This application only creates visualizations of KSeF invoices in XML format downloaded from the National e-Invoice System (e.g., using the tool KSeF XML Downloader). The generated invoices contain a QR code that can be used to check whether your invoice is in the KSeF system.
Starting with version 1.1.0 releases, it is now possible to convert KSeF XML invoices to PDF files based on the status of downloaded KSeF XML invoices using the KSeF XML Downloader tool . The KSeF XML Downloader tool saves the result of its operation, among other things, to a JSON file, which contains, among other things, the location of invoices in KSeF XML format. This file (JSON) can now be used as a source to indicate the location of KSeF XML invoice files.
Since version 1.2.0 releases, two parameters have been added:
- Silent mode (default: disabled)
- Show emoticons (default: disabled)
Since version 1.3.1 releases, as suggested by @niutech, to ensure long-term archiving, the PDF file is created in accordance with the PDF/A-3 standard - ISO 19005-3:2012. This standard ensures long-term archiving based on PDF version 1.7, which allows any data formats (e.g., XML, CSV, CAD, source Word files) to be embedded within the PDF file. PDF is a “container” that combines visual consistency with the original (for viewing) and raw data for automatic processing.
In version 1.3.5 releases, the default behavior when a KSeF PDF invoice file exists has been changed so that the KSeF invoice PDF file is not overwritten. In addition, a parameter has been added that can change this behavior, resulting in KSeF invoice PDF files being overwritten.
Click to see a sample PDF invoice generated based on the KSeF XML file.
Usage: ksef-pdf-generator.exe <ksef-xml-file> [options]
Options:
- [
-s], [--state] [X:\path\output-json.json] - Convert KSeF XML invoices to PDFs based on the state of the downloaded KSeF XML invoices by the tool KSeF XML Downloader - [
-o], [--output] [<ksef-pdf-file>] - Path to the output PDF file (default: XML file name changed to .pdf) - [
-e], [--emo] - Show emoticons in on-screen messages - [
-q], [--quiet] - Quiet mode, does not display messages on the screen - [
-w], [--overwrite] - Overwrite the PDF invoice file if it exists (default: do not overwrite the PDF invoice file if it exists) - [
-h], [--help] - Display this help message
Notes:
- The KSeF number is automatically detected from the XML file name. Format:
<nip>-<date>-<hash>-<codec_crc>.xml(e.g.,0101010101-20260201-1A2B3C456D7E-F8.xml) - If the KSeF number is not found, the value “NONE” is used.
- The QR code is generated based on the KSeF number. If the KSeF number is not found, the KSeF value will be used as “NONE” and the QR code will use “
0101010101-20260201-1A2B3C456D7E-F8” (KSeF number) as the default value for generating the QR code. - If you use the KSeF XML Downloader to generate invoices based on the status of downloaded invoices, the PDF invoice visualizations will be saved in the same location as the KSeF XML invoice files. The invoice name will be the same as the KSeF XML invoice file, with the extension changed from XML to PDF.
ksef-pdf-generator.exe 0101010101-20260201-1A2B3C456D7E-F8.xml
Output file:.\0101010101-20260201-1A2B3C456D7E-F8.pdf
ksef-pdf-generator.exe .\assets\invoice.xml -o output.pdf
Output file:.\output.pdf
ksef-pdf-generator.exe -s d:\\_ksef_\\ksef_invoices-output-json_20260217112540.json
Output file(s):
d:\\_ksef_\\0101010101-20260201-1A2B3C456D7A-F8.pdfd:\\_ksef_\\2020202020-20260202-1A2B3C456D7B-C9.pdf
...
d:\\_ksef_\\1919191919-20260209-1A2B3C456D7C-5A.pdf
Click to see a sample PDF invoice generated based on the KSeF XML file.