Skany dokumentów można dodawać do Taxxo na różne sposoby - po zalogowaniu przez przeglądarkę internetową, przesyłając pliki na dedykowany dla klienta adres e-mail, poprzez aplikację monitorującą foldery na dysku lokalnym TaxxoKurier lub za pomocą API.
Jak dodać skan dokumentu do Taxxo za pomocą API?
Krok 1. Jeżeli nie posiadasz jeszcze Klucza API – zapoznaj się z artykułem API - Jak rozpocząć integrację z Taxxo wykorzystując API?
Krok 2. Wykonaj logowanie do Taxxo API za pomocą metody POST /api/public/authenticate przy użycia Klucza API i uzyskaj Token Sesji – szczegółowy przykład znajdziesz w artykule API - Proces autoryzacji na przykładzie pobrania listy faktur sprzedaży z e-Faktury
Krok 3. Zamień plik dokumentu który chcesz wysłać do Taxxo (np. PDF) na postać Base64 – dla celów testowych można to zrobić to tutaj - https://www.base64encode.org/
Krok 4. Określ ConentType przesyłanego pliku. Musi być zgodny z https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types i akceptowalny jako rodzaj pliku przesyłanego do Taxxo. Dla pliku PDF będzie to application/pdf
Krok 5. Wykonaj metodę POST /api/public/document podając:
- w nagłówku Authorization pobrany w kroku drugim Token Sesji
- w sekcji FileDetails podaj FileName – nazwę pliku, ContentType – rodzaj pliku określony w kroku czwartym oraz Content - czyli zawartość pliku zamienioną na postać Base64
- możesz również określić typ dokumentu (jeżeli znasz), własny numer zewnętrzny (jeżeli nie używasz kodów paskowych na dokumencie), dowolną notatkę i wszelkie inne pola zgodne z opisem metody https://platforma2.taxxo.pl/api/documentation/#!/Documents/ApiPublicDocumentPost
curl --request POST \
--url https://platforma2.taxxo.pl/api/public/document \
--header 'content-type: application/json' \
--header 'authorization: TOKEN SESJI' \
--header 'accept: application/json' \
--data '{"FileDetails":{"FileName":"przyklad.pdf","ContentType":"application/pdf","Content":"ZAWARTOSC PLIKU W POSTACI BASE64"},"General":{"DocumentType":"PurchaseInvoice","ExternalDocumentId":"MojeID","Notes":"MojeID2"}}'
Krok 6. Po prawidłowym wykonaniu operacji powinna zostać zwrócona odpowiedź, która w sekcji Data zawiera ID dodanego dokumentu.
{
"Data": DocumentID,
"Status": 0,
"Message": "OK",
"ErrorCode": null
}
Pamiętaj, że jeżeli ustawisz pewne parametry dokument podczas dodawania do Taxxo (jak np. kwota czy kontrahent) a masz uruchomiony proces digitalizacji na koncie klienta Taxxo – proces digitalizacji może te dane nadpisać. Jeżeli masz komplet danych w swoim systemie i chcesz je przekazać do Taxxo w takiej postaci jak są – możliwe jest wyłączenie digitalizacji dla wskazanego dokumentu poprzez ustawienie flagi General \ NotToDigitalization.
Masz pytania odnośnie API – zapraszamy do kontaktu api@taxxo.pl