Dokumentacja

Przewodnik po aplikacji KSeFka

Synchronizacja KSeF#

Synchronizacja to proces wymiany danych między KSeFką a systemem KSeF. Pobiera nowe faktury otrzymane i aktualizuje statusy faktur wysłanych.

Synchronizacja ręczna#

Na Pulpicie kliknij Synchronizuj KSeF. Postęp widoczny jest jako komunikat "Synchronizowanie (X/Y)..." na pulpicie oraz obracająca się ikona w pasku bocznym.

Szybkie akcje na pulpicie z przyciskiem Synchronizuj KSeF
Przycisk Synchronizuj KSeF w szybkich akcjach na pulpicie.

Przycisk synchronizacji wymaga wgranego certyfikatu KSeF. Jeśli certyfikat nie jest skonfigurowany, zamiast przycisku synchronizacji pojawi się Skonfiguruj KSeF kierujący do ustawień.

Gdy działa proces pracy w tle (sekcja Ustawienia → KSeF → Praca w tle), ręczną synchronizację i wysyłkę z karty faktury wykonuje ten proces, a okno czeka na wynik. Gdy proces jest zatrzymany albo włączony jest tryb awaryjny, aplikacja wykonuje je sama, jak dotąd; ponowna wysyłka i pobieranie starszych faktur idą zawsze w aplikacji.

Synchronizacja automatyczna#

W Ustawienia → KSeF → Synchronizacja możesz skonfigurować:

Ustawienia synchronizacji KSeF
Automatyczna synchronizacja przy starcie i wybór częstotliwości.

Synchronizacja przy starcie#

Zaznacz Automatyczna synchronizacja przy starcie, aby aplikacja pobierała faktury przy każdym uruchomieniu. Opcja włączona domyślnie.

Częstotliwość#

Wybierz jak często aplikacja ma sprawdzać nowe faktury:

OpcjaOpis
Tylko przy starcieSynchronizacja wyłącznie przy uruchomieniu aplikacji
Co 5 minutDla firm z dużym przepływem faktur
Co 15 minut (domyślnie)Dobry balans między aktualnością a obciążeniem
Co 30 minutWystarczające dla większości firm
Co 1 godzinęGdy aktualność faktur nie jest krytyczna
Co 4 godzinyMinimalne obciążenie, rzadkie sprawdzanie

Kilka firm#

Synchronizacja automatyczna obejmuje każdą firmę z tokenem albo certyfikatem KSeF, nie tylko firmę wybraną w oknie. Po synchronizacji firmy aplikacja wysyła też faktury z jej kolejki do KSeF. Gdy KSeF ograniczy liczbę zapytań jednej firmie, czekają też pozostałe firmy z tym samym NIP-em, bo KSeF liczy limity na NIP.

Pracę w tle firmy wyłączysz w Ustawienia → Firmy → Edytuj → Praca w tle. Aplikacja przestaje wtedy synchronizować tę firmę i wysyłać jej faktury z kolejki. Faktury z kolejki czekają, a lista firm pokazuje ich liczbę. Ręczna synchronizacja i wysyłka działają bez zmian.

Proces pracy w tle#

Synchronizację automatyczną, wysyłkę z kolejki i faktury cykliczne wykonuje osobny proces ksefka serve, który aplikacja uruchamia razem z oknem i wznawia po awarii. Jego stan zobaczysz w Ustawienia → KSeF → Praca w tle i w menu Praca w tle: wersję, numer procesu, czas startu i ostatnią synchronizację w tle każdej firmy.

  • Zatrzymaj kończy proces po bieżącym przebiegu (najwyżej 30 sekund); do czasu Uruchom pracę w tle wykonuje sama aplikacja, jak w wersjach bez osobnego procesu.
  • Tryb awaryjny ("Nie uruchamiaj osobnego procesu") zostawia pracę w tle w procesie aplikacji, dopóki jest włączony. Użyj go, gdy osobny proces sprawia problemy; włączenie działa od następnego uruchomienia aplikacji, a po wyłączeniu wystarczy Uruchom.
  • Proces synchronizuje po kolei każdą firmę środowiska z włączoną pracą w tle. Ikona w pasku bocznym obraca się i powiadomienia o nowych fakturach pojawiają się dla firmy wybranej w oknie; stan pozostałych firm jest w sekcji Praca w tle.
  • Fakturę wystawioną firmy z włączoną pracą w tle, której wysyłkę przerwało zamknięcie aplikacji, proces wysyła ponownie tym samym numerem; pozostałe wracają do szkicu z przyczyną w szczegółach. Aplikacja pokazuje, co wysłał ponownie, co zostało w szkicu, a co zostało w stanie wysyłania do następnej próby.

Praca w tle po zamknięciu okna#

Domyślnie proces pracy w tle kończy się razem z oknem. W Ustawienia → KSeF → Praca w tle wybierzesz tryb Po zamknięciu okna, do wylogowania z systemu: KSeFka pobiera wtedy faktury z KSeF i wysyła faktury z kolejki także przy zamkniętym oknie, a po ponownym otwarciu aplikacja łączy się z działającym procesem. Przy pierwszym zamknięciu okna w tym trybie, gdy proces działa, aplikacja przypomina o tym jednym komunikatem.

Tryb Zawsze, od zalogowania do systemu uruchamia proces pracy w tle po każdym zalogowaniu do systemu, bez otwierania aplikacji. Aplikacja dodaje wtedy wpis startowy (bez uprawnień administratora): na macOS LaunchAgent, na Linuksie usługę użytkownika systemd, na Windows wpis autostartu. Przy każdym uruchomieniu w tym trybie sprawdza wpis i naprawia go, np. po przeniesieniu aplikacji do innego folderu. Gdy aplikacja działa z obrazu dysku (DMG) albo z Pobranych tuż po pobraniu (macOS uruchamia ją wtedy z tymczasowej lokalizacji), a CLI nie jest jeszcze zainstalowane z folderu Programy, tryb się nie włączy: przenieś aplikację do folderu Programy, otwórz ją stamtąd i zainstaluj CLI w Ustawieniach. Zatrzymaj wstrzymuje proces do następnego uruchomienia aplikacji albo logowania, a wybór innego trybu usuwa wpis.

Gdy masz licencję PRO albo okres próbny, a praca w tle kończy się z oknem, aplikacja po pierwszej udanej synchronizacji pyta, czy KSeFka ma pobierać faktury także wtedy, gdy jest zamknięta. Odpowiedź "Tak" włącza tryb Zawsze, od zalogowania do systemu, a "Tylko gdy KSeFka jest otwarta" zostawia tryb domyślny. Okno zamknięte bez odpowiedzi wraca raz, po pierwszej udanej synchronizacji przy następnym uruchomieniu aplikacji; potem tryb zmienisz już tylko w Ustawieniach. Pytanie pada osobno w każdym środowisku KSeF, ale nie częściej niż raz na uruchomienie aplikacji: środowisko, na które przełączysz się w trakcie pracy, zapyta przy jednym z następnych uruchomień.

Oba tryby pracy po zamknięciu okna wymagają licencji PRO albo okresu próbnego. Gdy jeden z nich jest włączony, baner w ostatnim tygodniu okresu próbnego ostrzega, że po jego końcu aplikacja przestanie pobierać faktury przy zamkniętym oknie. Gdy okres próbny się skończy, tryb wraca do "Tylko gdy aplikacja jest otwarta", a aplikacja mówi o tym przy uruchomieniu i w sekcji Praca w tle.

Postęp synchronizacji#

Podczas synchronizacji:

  • Na Pulpicie wyświetla się pasek postępu z liczbą przetworzonych faktur
  • W pasku bocznym ikona środowiska KSeF się obraca
  • Możesz kontynuować pracę w aplikacji — synchronizacja działa w tle

Wyniki synchronizacji#

Po zakończeniu pojawia się powiadomienie z podsumowaniem:

  • Liczba nowych faktur
  • Liczba zaktualizowanych faktur
  • Liczba pominiętych duplikatów

Jeśli wystąpiły problemy, wyświetlane są ostrzeżenia z opisem.

Środowiska KSeF#

KSeF udostępnia trzy środowiska: Test, Demo i Produkcja. Każde ma osobną bazę danych w KSeFce i wymaga osobnej konfiguracji firmy oraz certyfikatu. Szczegóły — patrz Pierwsze kroki.

Przełączanie: Ustawienia → KSeF → wybierz środowisko.

Ustawienia KSeF — środowisko, uwierzytelnianie i certyfikaty
Ustawienia → KSeF: wybór środowiska, uwierzytelnianie i status certyfikatu.
Przełączenie środowiska zmienia aktywną bazę danych. Dane z poprzedniego środowiska nie zostaną utracone — są dostępne po przełączeniu z powrotem.

Przy przełączaniu na Test lub Demo pojawi się ostrzeżenie o publicznym dostępie do danych — to środowiska testowe Ministerstwa Finansów, nie używaj ich do prawdziwych faktur.

Sesje KSeF#

Sesja to uwierzytelnione połączenie z systemem KSeF. Sesja jest wymagana do synchronizacji i wysyłania faktur.

Nawiązywanie sesji#

W Ustawienia → KSeF → Uwierzytelnianie kliknij Uwierzytelnij. Sesja zostanie nawiązana za pomocą wgranego certyfikatu.

Wygaśnięcie sesji#

Sesja KSeF może wygasnąć po pewnym czasie. Gdy to nastąpi, pojawi się powiadomienie. Kliknij Uwierzytelnij ponownie, aby nawiązać nową sesję.

Wylogowanie#

Kliknij Wyloguj, aby zakończyć bieżącą sesję.

Logowanie jako jednostka podrzędna (IDWew)#

Jeśli logujesz się do KSeF nie jako cała firma, lecz jako jej dział lub jednostka podrzędna, której token albo certyfikat KSeF wystawiono na identyfikator wewnętrzny IDWew (NIP-XXXXX — NIP firmy plus 5 cyfr) zamiast na główny NIP, ustaw ten kontekst w programie:

  1. Wejdź w Ustawienia → Firmy → (edytuj firmę) i znajdź sekcję "Kontekst uwierzytelniania KSeF".
  2. W polu "IDWew jednostki" wpisz identyfikator swojej jednostki (np. 1234567890-00001) i kliknij Zapisz.
Sekcja Kontekst uwierzytelniania KSeF w ustawieniach firmy
Kontekst uwierzytelniania KSeF — logowanie jako jednostka podrzędna (IDWew).

IDWew musi zaczynać się od NIP firmy — program to sprawdza i odrzuca niezgodny format. Zmiana zadziała przy następnym logowaniu (np. przy kolejnej synchronizacji), dlatego po jej zapisaniu zaloguj się ponownie.

Gdy kontekst IDWew jest ustawiony:

  • uwierzytelnianie wysyła do KSeF identyfikator typu InternalId zamiast NIP,
  • synchronizacja pobiera wyłącznie faktury tej jednostki (KSeF udostępnia je jako "Podmiot3"), a nie całego NIP firmy.

Pozostaw pole puste, aby uwierzytelniać się głównym NIP firmy (zachowanie domyślne).

To co innego niż Filtr jednostki na liście faktur otrzymanych (patrz Faktury otrzymane). Kontekst IDWew decyduje, jako kto logujesz się do KSeF i jakie faktury w ogóle się pobiorą; filtr jednostki tylko zawęża widok już zsynchronizowanych danych.

Certyfikat KSeF#

Certyfikat jest niezbędny do uwierzytelnienia i wysyłania faktur. Szczegóły wgrywania certyfikatu — patrz Pierwsze kroki.

Status certyfikatu widoczny w Ustawienia → KSeF:

  • Certyfikat ważny do [data] — certyfikat aktywny
  • Certyfikat wygasa za N dni — ostrzeżenie przy ważności poniżej 30 dni
  • Certyfikat wygasł — wymaga odnowienia

Rozwiązywanie problemów#

"Skonfiguruj KSeF" zamiast przycisku synchronizacji#

Brak certyfikatu. Przejdź do Ustawienia → KSeF i wgraj certyfikat.

"Błąd połączenia z KSeF"#

Nie udało się połączyć z serwerem KSeF. Sprawdź:

  • Czy jesteś uwierzytelniony — sesja mogła wygasnąć (patrz Ustawienia → KSeF → Uwierzytelnianie)
  • Połączenie z internetem
  • Czy certyfikat nie wygasł
  • Czy wybrane środowisko jest dostępne

Sesja wygasła#

Ponownie uwierzytelnij się w Ustawienia → KSeF → Uwierzytelnianie.

KSeF odrzucił dane logowania#

Gdy KSeF odrzuci token albo certyfikat firmy, unieważni uwierzytelnienie albo firma nie ma uprawnień, aplikacja pokaże o tym jeden komunikat i wstrzyma pracę w tle tej firmy. Przy firmie na liście pojawi się znacznik. Gdy wymienisz token albo certyfikat (certyfikat w Ustawienia → KSeF wybranej firmy) albo poprawisz IDWew (Ustawienia → Firmy → Edytuj, "Kontekst uwierzytelniania KSeF"), praca w tle wróci sama przy następnej synchronizacji. Jeśli dane logowania się nie zmieniły (np. uprawnienia nadano w KSeF później), kliknij Spróbuj ponownie w Ustawienia → Firmy → Edytuj → Praca w tle.

Brak nowych faktur po synchronizacji#

  • Faktury mogą pojawić się w KSeF z opóźnieniem (do kilku minut)
  • Sprawdź, czy wybrane środowisko jest prawidłowe
  • Upewnij się, że NIP firmy jest poprawny