Przeskocz do opisu głównego

Pobieranie dokumentów

GET /invoices/{environment}/{ksefNumber}

Pobiera dokument faktury z KSeF w wybranym formacie. Zawartość zwracana jest jako string zakodowany w base64. Wymaga aktywnej sesji KSeF.

Parametry ścieżki

ParametrTypWymaganyOpis
environmentstringtest, demo lub prod
ksefNumberstringNumer KSeF faktury

Parametry zapytania

ParametrTypDomyślnieOpis
docTypestringxmlTyp dokumentu

Dostępne typy dokumentów (docType)

WartośćOpisContent-Type
xmlXML faktury KSeFapplication/xml
pdfPDF faktury (wygenerowany przez ksef-pdf-generator z QR)application/pdf
qrObrazek QR w PNGimage/png
info

docType=pdf generuje pełny PDF po stronie serwera za pomocą ksef-pdf-generator, obsługując schematy FA(1), FA(2), FA(3) i FA_RR, z kodem QR weryfikacyjnym.

UPO

Aby pobrać UPO (Urzędowe Poświadczenie Odbioru), użyj dedykowanego endpointu: GET /invoices/{environment}/status/{referenceNumber}/{ksefNumber}/upo

Odpowiedź 200 — XML

{
"ksefNumber": "1234567890-20260101-ABCDEF-12",
"docType": "xml",
"contentType": "application/xml",
"content": "PD94bWwgdmVyc2lvbj0i...",
"fileName": "1234567890-20260101-ABCDEF-12.xml"
}

Odpowiedź 200 — PDF

{
"ksefNumber": "1234567890-20260101-ABCDEF-12",
"docType": "pdf",
"contentType": "application/pdf",
"content": "JVBERi0xLjQK...",
"fileName": "1234567890-20260101-ABCDEF-12.pdf",
"qrVerificationUrl": "https://qr-test.ksef.mf.gov.pl/invoice/..."
}

Odpowiedź 200 — QR

{
"ksefNumber": "1234567890-20260101-ABCDEF-12",
"docType": "qr",
"contentType": "image/png",
"content": "iVBORw0KGgoAAAA...",
"fileName": "1234567890-20260101-ABCDEF-12-qr.png",
"qrVerificationUrl": "https://qr-test.ksef.mf.gov.pl/invoice/..."
}
PoleTypOpis
ksefNumberstringNumer KSeF faktury
docTypestringŻądany typ dokumentu (xml, pdf, qr)
contentTypestringTyp MIME zawartości
contentstringZawartość dokumentu zakodowana w base64
fileNamestringSugerowana nazwa pliku
qrVerificationUrlstringURL weryfikacyjny QR (tylko dla typów pdf i qr)

Kody błędów

KodOpis
400Nieprawidłowy parametr docType
401Brak autoryzacji
404Brak aktywnej sesji KSeF lub faktura nie znaleziona
500Błąd generowania PDF
502Błąd KSeF