Przejdź do głównej zawartości

Czym jest OpenKSeF?

Beta

OpenKSeF jest w fazie beta. Projekt jest aktywnie rozwijany -- mogą wystąpić zmiany w API, strukturze bazy danych i konfiguracji. Używaj w środowiskach testowych lub z pełną świadomością aktualnego stanu projektu.

OpenKSeF to otwartoźródłowy system do synchronizacji i przeglądania faktur z polskiego Krajowego Systemu e-Faktur (KSeF). Umożliwia automatyczne pobieranie faktur, ich przeglądanie przez portal webowy lub aplikację mobilną, oraz zarządzanie wieloma firmami z jednego miejsca.

Dla kogo?

OpenKSeF jest przeznaczony dla:

  • Programistów i administratorów -- którzy chcą postawić własną instancję i mieć pełną kontrolę nad danymi fakturowymi
  • Księgowych i właścicieli firm -- którzy szukają prostego narzędzia do przeglądania faktur z KSeF bez opłat abonamentowych
  • Zespołów IT w firmach -- które potrzebują self-hosted rozwiązania zgodnego z polskimi przepisami

Co potrafi OpenKSeF?

FunkcjaOpis
Synchronizacja fakturAutomatyczne pobieranie faktur z KSeF w tle
Portal webowyReact SPA z dashboardem, listą faktur, zarządzaniem firmami
Aplikacja mobilna.NET MAUI na Android i iOS z powiadomieniami push
Multi-tenantWiele firm na jednej instancji, izolacja danych per użytkownik
Powiadomienia pushSignalR (lokalne) + relay/Firebase (zdalne) + email
BezpieczeństwoKeycloak (OIDC), szyfrowanie tokenów KSeF (AES-256), HTTPS
Self-hostingDocker Compose -- jedno polecenie i gotowe

Architektura

┌─────────────────────────────────────────────────┐
│ Docker Compose │
│ │
│ ┌──────────┐ ┌──────────┐ ┌───────────────┐ │
│ │ API │ │ Worker │ │ Portal (React)│ │
│ │ (.NET 8) │ │ (.NET 8) │ │ │ │
│ └────┬─────┘ └────┬─────┘ └───────────────┘ │
│ │ │ │
│ ┌────┴──────────────┴────┐ ┌───────────────┐ │
│ │ PostgreSQL │ │ Keycloak │ │
│ │ │ │ (OIDC) │ │
│ └────────────────────────┘ └───────────────┘ │
│ │
│ ┌──────────────────────────────────────────┐ │
│ │ nginx Gateway (:8080) │ │
│ │ / portal /api/ API /auth/ Keycloak │ │
│ └──────────────────────────────────────────┘ │
└─────────────────────────────────────────────────┘


┌───────────────┐ ┌──────────────┐
│ Aplikacja │ │ KSeF │
│ mobilna MAUI │ │ (MF API) │
└───────────────┘ └──────────────┘

Portal webowy

Dashboard portalu

Lista faktur

Podgląd faktury

Dane przelewu i QR

Aplikacja mobilna

Lista fakturSzczegóły fakturyKod QR przelewu
Lista fakturSzczegóły fakturyQR przelewu

Następne kroki