Dzień dobry,
W dokumentacji API ( https://github.com/fakturownia/api / https://app.fakturownia.pl/api ) brakuje opisuje scheme'y odpowiedzi na te zapytania. T.j. nie wiem jakie pola (i o jakim typie) będą znajdować się w odpowiedzi. A nawet jeśli empirycznie sprawdzę jakieś przykładowe faktury, to mając takie przykładowe pole "status: paid", to ja i tak nie wiem z takiej odpowiedzi, jakie jeszcze inne wartości może przyjmować to pole.
Fajnie by było jakby to zostało udokumentowane
API - dokumentacja odpowiedzi (HTTP response) pytanie Rozwiązane
anonim
2025-05-27 14:47
Odpowiedź główna
Dzień dobry,
dziękujemy za sugestię - przekażę ją do naszego działu odpowiedzialnego za rozwój produktu.
W razie dodatkowych pytań, pozostaję do dyspozycji.
Pozdrawiam
Julia
Komentarze
anonim
Ale to i tak wymaga drobnej poprawki w dokumentacji, ponieważ:
- w spisie treści brakuje odpowiedniego odnośnika, a sekcja jest na końcu i nie ma nagłówka, przez co trudno ją znaleźć
- umiejscowienie tego opisu w dokumencie jest nieintuicyjne - t.j. najpierw są opisy zapytań typu "GET" i absolutny brak opisu odpowiedzi, po czym znajdują się opisy mutacji, operacji które coś modyfikują, następnie jakieś losowe rzeczy i nagle w środku dokumentu 'out of the blue' jest opis 'pola faktury'
-
2025-05-27 14:54
juliaz
dziękujemy za sugestię - przekażę ją do naszego działu odpowiedzialnego za rozwój produktu.
W razie dodatkowych pytań, pozostaję do dyspozycji.
Pozdrawiam
Julia
2025-05-28 16:35
anonim
Dokumentacja jest nieaktualna i/lub niekompletna.
Przykładowo, w dokumentacji pole "kind" ma nastepujace wartosci:
```
"vat" - faktura VAT
"proforma" - faktura Proforma
"bill" - rachunek
"receipt" - paragon
"advance" - faktura zaliczkowa
"final" - faktura końcowa
"correction" - faktura korekta
"vat_mp" - faktura MP
"invoice_other" - inna faktura
"vat_margin" - faktura marża
"kp" - kasa przyjmie
"kw" - kasa wyda
"estimate" - zamówienie
"vat_mp" - faktura MP
"vat_rr" - faktura RR
"correction_note" - nota korygująca
"accounting_note" - nota księgowa
"client_order" - własny dokument nieksięgowy
"dw" - dowód wewnętrzny
"wnt" - Wewnątrzwspólnotowe Nabycie Towarów
"wdt" - Wewnątrzwspólnotowa Dostawa Towarów
"import_service" - import usług
"import_service_eu" - import usług z UE
"import_products" - import towarów - procedura uproszczona
"export_products" - eksport towarów
```
a w odpowiedzi otrzymałem wartość "kind":"canceled"
2025-05-29 13:44
juliaz
zmienna "kind" o wartości "canceled" pojawia się dla dokumentów, które zostały anulowane (Anulowanie faktur).
Opcje wymienione w dokumentacji to po prostu różne typy / rodzaje dokumentów.
Pozdrawiam
Julia
2025-05-29 16:39