Skip to content

KSeFGuard/ksef-guard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

KSeF Guard

Walidator faktur FA(3) offline — sprawdź XML, zanim wyślesz do KSeF. Offline FA(3) invoice validator — check your XML before you send it to KSeF.

🌐 Strona / Website · ⬇️ Pobierz / Download · 📄 Raport zgodności / Conformance report

KSeF · FA(3) · faktura ustrukturyzowana · walidacja offline · e-invoicing · Poland · proprietary, free tier · Windows GUI + Linux CLI


KSeF Guard validating an FA(3) invoice — a failed rule shown with its bilingual explanation, the legal citation, and the exact location in the XML

What this repository is: the public home of KSeF Guard — README, download links, checksums, the conformance report, a CI example, and the issue tracker. It contains no engine source code. KSeF Guard is a commercial / proprietary product with a free tier — see Is this open source?.


🇵🇱 Polski

KSeF Guard to offline'owy walidator polskich faktur FA(3) / KSeF. Sprawdza pełny schemat XSD FA(3) oraz 128 reguł biznesowych z podstawą prawną, dwujęzycznie (PL/EN) — i wychwytuje 107 problemów, których samo KSeF nie egzekwuje, zanim wyślesz fakturę. Wszystko działa lokalnie — dane faktur nie opuszczają komputera.

Dlaczego to ważne

KSeF sprawdza składnię. Prawo wymaga treści. W teście 256 faktur wobec oficjalnego API testowego KSeF system przyjął 98 faktur naruszających reguły, których nie sprawdza. KSeF Guard wychwytuje wszystkie 107, których API nie egzekwuje — 55 wymogów prawnych i 52 dobre praktyki / bezpieczeństwo — zanim faktura trafi do urzędu.

Co potrafi

  • Pełna walidacja XSD FA(3) (schemat 1-0E) + 128 reguł biznesowych/prawnych
  • Offline — żadnych przesyłek do chmury; prywatność z definicji
  • Dwujęzyczne raporty (PL/EN) z dokładną lokalizacją błędu, „co poprawić" i cytatem z przepisu
  • Walidacja wsadowa (batch) całych katalogów faktur klientów
  • Eksport do PDF / CSV / JSON (raporty gotowe do audytu)
  • ✅ Mocna obsługa faktur walutowych, korekt (KOR), dat, NIP-ów i pól szczególnych

Dla kogo

Przede wszystkim biura rachunkowe i działy finansowe, które masowo wysyłają FA(3) do KSeF i potrzebują pewności przed wysyłką oraz raportów dla klientów.

Pobierz

  • Windows — instalator MSI lub wersja przenośna ZIP
  • LinuxCLI (do automatyzacji / CI-CD)

➡️ www.ksefguard.pl

Cennik (model: darmowa aplikacja + klucz licencyjny)

Plan Cena Co zawiera
Free 0 € wszystkie 128 reguł, 10 plików/dzień, GUI + CLI (tekst), 1 urządzenie
Standard €39/mies. (€384/rok) eksport PDF/CSV/JSON, konfiguracja reguł, 5 000 plików/dzień, 3 urządzenia
Pro €89/mies. (€864/rok) bez limitu plików, white-label PDF, presety eksportu, konfiguracja YAML, 10 urządzeń

Darmowy plan ma komplet reguł. Plany płatne to przepustowość i raporty dla biura — wsad, eksporty PDF/CSV/JSON, więcej urządzeń, ślad audytowy.


🇬🇧 English

KSeF Guard is an offline validator for Polish FA(3) / KSeF e-invoices. (KSeF is Poland's national e-invoicing system; FA(3) is its mandatory invoice XML schema.) It checks the full FA(3) XSD plus 128 business rules with legal citations, bilingual (PL/EN) — and catches 107 issues KSeF itself does not enforce, before you submit. Everything runs locally — invoice data never leaves the device.

Why it matters

KSeF checks syntax. The law requires substance. In a test of 256 invoices against the official KSeF test API, it accepted 98 that break rules it doesn't check. KSeF Guard catches all 107 the API misses — 55 legal requirements and 52 best-practice / security checks — before the invoice reaches the tax office.

What it does

  • Full FA(3) XSD validation (schema 1-0E) + 128 business/legal rules
  • Offline — no cloud uploads; private by design
  • Bilingual reports (PL/EN) with exact error location, "what to fix", and the legal quote
  • Batch validation of whole folders of client invoices
  • Export to PDF / CSV / JSON (audit-ready reports)
  • ✅ Strong on foreign-currency invoices, corrections (KOR), dates, NIPs, and special fields

Who it's for

Primarily accounting offices (biura rachunkowe) and finance teams submitting FA(3) to KSeF at volume, who need pre-submission certainty and client-ready reports.

Download

  • WindowsMSI installer or portable ZIP
  • LinuxCLI (for automation / CI-CD)

➡️ www.ksefguard.pl

Pricing (model: free app + license key)

Plan Price Includes
Free €0 all 128 rules, 10 files/day, GUI + CLI (text), 1 machine
Standard €39/mo (€384/yr) PDF/CSV/JSON export, rule config, 5,000 files/day, 3 machines
Pro €89/mo (€864/yr) unlimited files, white-label PDF, export presets, YAML config, 10 machines

The free tier runs the full rule set. Paid is office throughput + client reports — batch, PDF/CSV/JSON exports, more machines, audit trail.


KSeF Guard rule configuration — each of the 128 rules traces to a legal source (a VAT Act article or an FA(3) brochure table), with Recommended / Maximum / Essential presets
Every rule traces to a legal source — a VAT Act article or an FA(3) brochure table. · Każda reguła ma udokumentowane źródło prawne.

🤖 Use the CLI in CI/CD

Gate your pipeline on offline FA(3) validation — see .github/workflows/validate-fa3-example.yml. In short:

# Download the free Linux CLI
curl -fsSL -o ksef-guard.tar.gz https://www.ksefguard.pl/downloads/ksef-guard-linux-amd64.tar.gz
tar xzf ksef-guard.tar.gz && chmod +x ksef-guard

# Validate a folder of invoices (non-zero exit on errors → fails the build)
./ksef-guard validate --format summary ./invoices/

# Or produce a machine-readable report
./ksef-guard validate --format json --output report.json ./invoices/

Formats: text · summary · json · csv · pdf. Run ./ksef-guard --help for all flags.

🔒 Verify your download

Every release on ksefguard.pl/downloads publishes a SHA-256 checksum. After downloading, confirm it matches:

# Linux / macOS
sha256sum ksef-guard-linux-amd64.tar.gz
# Windows (PowerShell)
Get-FileHash .\ksef-guard_1.0.0_x64_en-US.msi -Algorithm SHA256

📦 Sample invoices

A pack of example FA(3) XML files (valid + intentionally failing) is available for trying the validator — download the sample XML pack.

📊 Proof: the conformance report

We submitted 256 real invoices to the official KSeF test API and recorded which non-compliant ones it accepted (it accepted 98). The full methodology + per-rule results are in the public conformance report (PDF).

❓ Is this open source? / Czy to open source?

No / Nie. The validation engine is proprietary (commercial). This repository is the product's public home — README, download links, checksums, conformance report, sample pack, CI examples, and the issue tracker — and contains no engine source code. The app is free to download and use (free tier); paid tiers unlock higher volume and reports.

🛟 Support

  • Bugs / rule questions: open an issue.
  • Billing, licenses, accounts: email support@ksefguard.pl (please don't put account details in public issues).

🔗 Links


KSeF Guard is a technical validation tool, not tax advice. · KSeF Guard to narzędzie techniczne, nie porada podatkowa.

About

Offline FA(3) / KSeF e-invoice validator — 128 rules, bilingual reports, runs locally. Windows GUI + Linux CLI. Free tier + paid.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors