0 głosów

API - dokumentacja odpowiedzi (HTTP response) pytanie Nowe

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

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

Avatar sugester medium
anonim
Mea culpa! Pola jednak są udokumentowane!

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
juliaz
Odpowiedź główna (zespół fakturownia.pl)   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

2025-05-28 16:35


Avatar sugester medium
anonim
Dzień dobry,

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
juliaz
Odpowiedź główna (zespół fakturownia.pl)   Dzień dobry,

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


Avatar sugester medium
anonim
Dzien dobry,

Kolejny przyklad brakow w dokumentacji:

fakturownia zwraca odpowiedz z wypelnionym polem o nazwie "exchange_rate" (jako pole faktury). W dokumentacji nie ma mowy o takim polu (ctrl+f pokazuje 0 wynikow).

Dodatkowo API zwraca tez bardzo podobne pola, np. "exchange_currency_rate", ktore jest opisane w dokumentacji, ale w naszym przypadku to pole nie zawiera zadnych wartosciowych danych. Zauwazylem tez takie pola jak "exchange_rate_den" czy "exchange_currency_rate_den" - rowniez nieopisane w dokumetacji.

Taka usluga, jaka Panstwo oferuja, wymaga aby klienci mieli dostep do dokladnej, rzetelnej oraz aktualnej dokumentacji. Bardzo bym prosil o przyjrzenie sie tej dokumentacji i poprawienie jej. Z gory dziekuje

2025-06-12 16:23


tomaszs
tomaszs
Odpowiedź główna (zespół fakturownia.pl)   Dzień dobry,

dziękujemy za wszelkie sugestie w temacie naszej dokumentacji API.
Staramy się, aby była ona jak najbardziej czytelna i aktualna.

Należy wziąć pod uwagę fakt, że funkcje naszego programu są stale rozbudowywane co może powodować sytuacje, gdzie część pól zwracanych przez API nie jest ujęta w dokumentacji.

Jeśli pojawiają się niejasności co do zwracanych pól, nasza obsługa stara się wyjaśnić ich działanie po kontakcie Klienta który jest nią zainteresowany.

Pozdrawiam, Tomasz

2025-06-12 16:45


Avatar sugester medium
anonim
Dzien dobry,

Dziekuje za zainteresowanie problemem!

Przy okazji chcialbym zapytac jak dostac sie do informacji w kontekscie faktur korygujacych. T.j. w interfejsie UI na Waszej stronie, mozna znalezc informacje ze dana faktura koryguje inna fakture (ktora + odnosnik do tej faktury) oraz z drugiej strony, ze dana faktura zostala skorygowana przez inna fakture (ktora + odnosnik).

Jak moge dostac sie do tej informacji (odpowiednie ID faktury itd.) z poziomu API?


2025-06-13 13:01


tomaszs
tomaszs
Odpowiedź główna (zespół fakturownia.pl)   Dzień dobry,

po pobraniu faktury korygującej przez API nie znajdziemy informacji na temat numeru dokumentu korygowanego a jego ID.
Odpowiada za to parametr: "from_invoice_id".

Pozdrawiam, Tomasz

2025-06-13 13:27


Avatar sugester medium
anonim
Dziekuje!

A w druga strone? T.j. majac fakture, skad wziac informacje, ze zostala ona skorygowana i przez ktora fakture?

2025-06-13 13:34


tomaszs
tomaszs
Odpowiedź główna (zespół fakturownia.pl)   Niestety taka informacja nie jest zwracana przez API, ponieważ dane te nie zawierają się na podglądzie korygowanego dokumentu.

Pozdrawiam, Tomasz

2025-06-13 14:11


Avatar sugester medium
anonim
Ale UI na Waszej stronie wyswietla, ze dana faktura zostala skorygowana przez inna i mozna kliknac w odnosnik i zobaczyc te fakture. Czyli taka informacja musi byc gdzies dostepa

2025-06-13 14:13


tomaszs
tomaszs
Odpowiedź główna (zespół fakturownia.pl)   Zgadza się, jednak nie są to dane dostępne do pobrania przez API.

Pozdrawiam, Tomasz

2025-06-13 14:17


Avatar sugester medium
anonim
Rozumiem. A istnieje szansa, zeby te dane pojawily sie w API?

2025-06-13 14:22


tomaszs
tomaszs
Odpowiedź główna (zespół fakturownia.pl)   Niestety taka opcja nie jest planowana w najbliższym czasie.

Pozdrawiam, Tomasz

2025-06-13 16:54


Avatar sugester medium
anonim
Szkoda. Ale dziekuje za odpowiedzi!

Milego weekendu

2025-06-13 17:25


Dodaj komentarz