Przeskocz do opisu głównego

Pobieranie faktur

POST /invoices/{environment}

Wyszukuje faktury w KSeF dla podanego zakresu dat. Wymaga aktywnej sesji KSeF (wcześniejsze wywołanie POST /auth/{environment}).

Parametry ścieżki

ParametrTypWymaganyOpis
environmentstringtest, demo lub prod

Request Body

{
"dateFrom": "2026-01-01 00:00:00",
"dateTo": "2026-01-31 23:59:59",
"subjectType": "sales",
"pageSize": 10,
"pageNr": 1
}
PoleTypWymaganyDomyślnieOpis
dateFromstringData początkowa (yyyy-MM-dd lub yyyy-MM-dd HH:mm:ss)
dateTostringData końcowa (yyyy-MM-dd lub yyyy-MM-dd HH:mm:ss)
subjectTypestringsalesTyp listy faktur: sales, purchases, thirdParty
pageSizeinteger10Liczba faktur na stronę (1–100)
pageNrinteger1Numer strony (od 1)

Typy podmiotów (subjectType)

WartośćOdpowiednik KSeFOpis
salesSubject1Faktury, na których Twoja firma jest sprzedawcą (domyślnie)
purchasesSubject2Faktury, na których Twoja firma jest nabywcą
thirdPartySubject3Faktury, w których Twoja firma jest podmiotem trzecim

Odpowiedź 200

{
"invoices": [
{
"ksefNumber": "1234567890-20260101-ABCDEF-12",
"invoiceNumber": "FV/2026/01/001",
"sellerNip": "9570429696",
"sellerName": "Firma XYZ",
"buyerNip": "1234567890",
"buyerName": "Klient ABC",
"netAmount": "1000.00",
"vatAmount": "230.00",
"grossAmount": "1230.00",
"currency": "PLN",
"invoiceType": "VAT",
"issueDate": "2026-01-15 00:00:00"
}
],
"pageNr": 1,
"pageSize": 10,
"hasMore": false
}
PoleTypOpis
invoicesarrayLista podsumowań faktur
pageNrintegerBieżący numer strony
pageSizeintegerLiczba faktur na stronę
hasMorebooleanCzy dostępne są kolejne strony

Pola podsumowania faktury:

PoleTypOpis
ksefNumberstringNumer KSeF faktury
invoiceNumberstringNumer faktury (element P_2)
sellerNipstringNIP sprzedawcy
sellerNamestringNazwa firmy sprzedawcy
buyerNipstringNIP nabywcy
buyerNamestringNazwa firmy nabywcy
netAmountstringKwota netto
vatAmountstringKwota VAT
grossAmountstringKwota brutto
currencystringKod waluty (np. PLN)
invoiceTypestringTyp faktury
issueDatestringData wystawienia
Synchronizacja DB

Podczas pobierania faktur z KSeF, ksef-proxy automatycznie wykonuje synchronizację danych:

  • Faktury zaliczkowe (ROZ ↔ ZAL) — wykrywane i wiązane przez advance_groups / advance_group_invoices
  • Faktury korygujące (KOR) — wiązane z fakturami oryginalnymi przez invoice_corrections
  • Metadane synchronizacjiinvoice_sync_meta aktualizowane o znacznik czasu ostatniej synchronizacji i liczbę nieprzeczytanych

Kody błędów

KodOpis
400Błędne parametry (brak dat, zły format)
401Brak autoryzacji
404Brak aktywnej sesji KSeF
502Błąd KSeF