KSeF API lista sesji – pobieranie metadanych

Listowanie sesji w KSeF API 2.0

Endpoint GET /api/v2/sessions pozwala na pobranie listy wszystkich sesji (interaktywnych i wsadowych) w określonym zakresie dat. Lista zawiera numery referencyjne sesji, daty utworzenia, typy sesji (online/batch) i statusy.

Endpoint jest dostępny od wersji API 2.0 i umożliwia odzyskanie informacji o sesjach po awarii systemu lub synchronizację danych z KSeF. Znając numer referencyjny sesji, możesz pobrać szczegóły sesji i listę faktur wysłanych w danej sesji.

Lista sesji jest przydatna do zarządzania wysyłkami, monitorowania statusu faktur, odzyskiwania danych po awarii oraz synchronizacji stanu między lokalnym systemem a KSeF.

Instrukcja krok po kroku

1. Wywołaj endpoint listy sesji

Wywołaj GET /api/v2/sessions z parametrami zapytania określającymi zakres dat (dateFrom, dateTo) oraz opcjonalnie typ sesji (online/batch). Endpoint wymaga autoryzacji accessToken w nagłówku Authorization: Bearer.

2. Przetwórz listę sesji

Otrzymasz listę sesji zawierającą dla każdej sesji: numer referencyjny (referenceNumber), datę utworzenia, typ sesji (online/batch), status oraz metadane. Przetwórz listę, aby zidentyfikować sesje, które Cię interesują.

3. Pobierz szczegóły sesji

Dla każdej sesji z listy możesz pobrać szczegóły używając GET /api/v2/sessions/{referenceNumber} (dla sesji interaktywnych) lub GET /api/v2/sessions/batch/{referenceNumber} (dla sesji wsadowych). Szczegóły zawierają metadane sesji, status i informacje o fakturach.

4. Pobierz faktury z sesji

Używając numeru referencyjnego sesji, możesz pobrać listę faktur wysłanych w danej sesji: GET /api/v2/sessions/{referenceNumber}/invoices (dla sesji interaktywnych) lub GET /api/v2/sessions/batch/{referenceNumber}/invoices (dla sesji wsadowych).

Najczęstsze problemy i rozwiązania

Jak filtrować sesje według typu?

Endpoint GET /api/v2/sessions zwraca zarówno sesje interaktywne, jak i wsadowe. Możesz filtrować wyniki po stronie klienta na podstawie typu sesji zwróconego w odpowiedzi. Sprawdź dokumentację API, czy dostępne są parametry zapytania do filtrowania według typu.

Jak pobrać sesje z dłuższego okresu?

Użyj parametrów zapytania dateFrom i dateTo, aby określić zakres dat. Jeśli potrzebujesz sesji z dłuższego okresu, możesz wykonać kilka zapytań dla kolejnych zakresów dat lub użyć paginacji, jeśli jest dostępna. Sprawdź dokumentację API dotyczącą limitów i paginacji.

Różnice między sesjami interaktywnymi a wsadowymi

Sesje interaktywne (online) są używane do wysyłki pojedynczych faktur w czasie rzeczywistym. Sesje wsadowe (batch) są używane do wysyłki wielu faktur w paczkach. Typ sesji jest zwracany w odpowiedzi GET /api/v2/sessions. Różne endpointy są używane do pobierania szczegółów: /sessions/{referenceNumber} dla interaktywnych, /sessions/batch/{referenceNumber} dla wsadowych.

Jak sprawdzić status faktur w sesji?

Pobierz listę faktur z sesji używając GET /api/v2/sessions/{referenceNumber}/invoices (dla interaktywnych) lub GET /api/v2/sessions/batch/{referenceNumber}/invoices (dla wsadowych). Lista zawiera statusy faktur, numery KSeF i metadane. Możesz również sprawdzić szczegóły pojedynczej faktury używając odpowiednich endpointów.

Endpoint GET /api/v2/sessions

Endpoint zwraca listę wszystkich sesji (interaktywnych i wsadowych) w określonym zakresie dat. Wymaga parametrów zapytania: dateFrom i dateTo (zakres dat) oraz opcjonalnie innych parametrów filtrujących. Endpoint wymaga autoryzacji accessToken w nagłówku Authorization: Bearer. Lista zawiera dla każdej sesji: numer referencyjny, datę utworzenia, typ sesji, status i metadane.

Format odpowiedzi

Odpowiedź zawiera listę sesji z metadanymi: referenceNumber (numer referencyjny sesji), createdAt (data utworzenia), sessionType (online/batch), status (status sesji), oraz opcjonalnie inne metadane (liczba faktur, data zamknięcia, itp.). Format może się różnić w zależności od typu sesji (interaktywna vs wsadowa).

Pobieranie szczegółów sesji

Znając numer referencyjny sesji z listy, możesz pobrać szczegóły sesji: GET /api/v2/sessions/{referenceNumber} dla sesji interaktywnych lub GET /api/v2/sessions/batch/{referenceNumber} dla sesji wsadowych. Szczegóły zawierają pełne metadane sesji, status, informacje o fakturach i UPO.

Zastosowania listy sesji

Lista sesji jest przydatna do: odzyskiwania danych po awarii systemu (identyfikacja sesji, które zostały utracone), synchronizacji stanu między lokalnym systemem a KSeF, monitorowania statusu wysyłek faktur, zarządzania sesjami i analizy historii wysyłek. Endpoint umożliwia kompleksowe zarządzanie sesjami i fakturach w systemie KSeF.

FAQ

Powiązane tematy

• KSeF API sesja odzyskiwanie danych
• KSeF API sesja wsadowa upload
• KSeF API pobieranie faktur