Instrukcja w PDF : API – jak wystawić korekty przez Taxxo
Przygotowanie
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 w artykule API - Proces autoryzacji na przykładzie pobrania listy faktur sprzedaży z e-Faktury
Scenariusz 1: Wystawienie korekty do faktury w Taxxo – dodanie nowych pozycji
Scenariusz opisuje wystawienie korekty do istniejącej już w systemie Taxxo faktury, w której zostaną dodane nowe pozycje, bez modyfikacji już istniejących.
Krok 1. Stwórz opis korekty w formacie JSON z minimalną wymaganą ilością informacji zgodnie z dokumentacją https://platforma2.taxxo.pl/api/documentation/#!/Invoices/ApiPublicInvoiceByInvoiceIdCorrectionPost uzupełniając pole NewItems
Należy uzupełnić (minimalnie):
- Dodać jeden element NewItems z wypełnionym polem ProductName
- Dodać jeden element ChangedItems z wypełnionym polem ParentItemId
Nieuzupełnione dane nowych pozycji zostaną uzupełnione wartościami domyślnymi, a inne nieuzupełnione dane korekty zostaną przepisane z faktury korygowanej.
Krok 2. Tak przygotowany obiekt wyślij do metody POST /api/public/invoice/{invoiceId}/correction zastępując {invoiceId} ID Faktury, wpisując dodatkowo do nagłówka Authorization wartość otrzymanego w sekcji Przygotowanie/Krok2 Tokenu Sesji
Przykładowe żądanie:
curl --request POST
--url https://platforma2.taxxo.pl/api/public/invoice/ID_FAKTURY/correction \
--header 'authorization: TOKEN_SESJI' \
--header 'Content-Type: application/json' \
--data '{
"General": {
"CorrectionReason": "Powód korekty"
},
"NewItems": [
"ProductName": "Nazwa nowego produktu",
"NetPrice": 1000,
"LineDescription": "Nowy produkt na korekcie"
}
]
}'
Krok 3. Jeżeli operacja przebiegnie prawidłowo w odpowiedzi w sekcji Data znajdzie się ID Faktury Korekty (wystawionej)
{
"Data": ID_FAKTURY_KOREKTA,
"Status": 0,</p><br><p> "Message": "OK",
"ErrorCode": null,
"AdditionalData": NUMER_FAKTURY_KOREKTA
}
Scenariusz 2: Wystawienie korekty do faktury w Taxxo – modyfikacja istniejących pozycji
Scenariusz opisuje wystawienie korekty do istniejącej już w systemie Taxxo faktury, która modyfikuje już istniejące pozycje.
Krok 1. Stwórz opis korekty w formacie JSON z minimalną wymaganą ilością informacji zgodnie z dokumentacją https://platforma2.taxxo.pl/api/documentation/#!/Invoices/ApiPublicInvoiceByInvoiceIdCorrectionPost uzupełniając pole ChangedItems
Należy wypełnić (minimalnie):
Nieuzupełnione dane faktury oraz modyfikowanych pozycji zostaną przepisane z faktury korygowanej.
Uwaga! ID Pozycji Faktury Korygowanej uzupełniające pole ParentItemId to identyfikator oryginalnej pozycji z faktury korygowanej (ItemId). Aby uzyskać wartość można skorzystać z metody API pobierającej fakturę korygowaną, np. https://platforma2.taxxo.pl/api/documentation/#!/Invoices/ApiPublicInvoiceByInvoiceIdGet
Krok 2. Tak przygotowany obiekt wyślij do metody POST /api/public/invoice/{invoiceId}/correction zastępując {invoiceId} ID Faktury, wpisując dodatkowo do nagłówka Authorization wartość otrzymanego w sekcji Przygotowanie/Krok2 Tokenu Sesji
Przykładowe żądanie:
curl --request POST \
--url https://platforma2.taxxo.pl/api/public/invoice/ID_FAKTURY/correction \
--header 'authorization: TOKEN_SESJI' \
--header 'Content-Type: application/json' \
--data '{
"General": {
"CorrectionReason": "Powód korekty"
},
"ChangedItems": [
{
"ParentItemId": ID_POZYCJI_FAKTURY_KORYGOWANEJ,
"NetPrice": 1000.00
}
]
}'
Krok 3. Jeżeli operacja przebiegnie prawidłowo w odpowiedzi w sekcji Data znajdzie się ID Faktury Korekty (wystawionej)
{
"Data": <b>ID_FAKTURY_KOREKTA,
"Status": 0,
"Message": "OK",
"ErrorCode": null,
"AdditionalData": NUMER_FAKTURY_KOREKTA
}
Scenariusz 3: Wystawienie korekty do faktury w Taxxo – modyfikacja danych nagłówkowych
Scenariusz opisuje możliwość wystawienia korekty do istniejącej już faktury w Taxxo bez modyfikacji istniejących pozycji, lub dodania nowych pozycji – ze zmianą informacji znajdujących się w nagłówku faktury np. danych adresowych, informacji do płatności, dat itp.
Krok 1. Stwórz opis korekty w formacie JSON zgodnie z dokumentacją https://platforma2.taxxo.pl/api/documentation/#!/Invoices/ApiPublicInvoiceByInvoiceIdCorrectionToZeroPost uzupełniając dane nagłówkowe, które chcesz zmodyfikować.
Nieuzupełnione dane faktury korygującej zostaną przepisane z istniejącej korekty.
Krok 2. Tak przygotowany obiekt wyślij do metody POST /api/public/invoice/{invoiceId}/correction zastępując {invoiceId} ID Faktury, wpisując dodatkowo do nagłówka Authorization wartość otrzymanego w sekcji Przygotowanie/Krok2 Tokenu Sesji
curl --request POST \
--url https://platforma2.taxxo.pl/api/public/invoice/ID_FAKTURY/correction \
--header 'authorization: TOKEN_SESJI' \
--header 'Content-Type: application/json' \
--data ' {
"General": {
"CorrectionReason": "Powód korekty"
},
"PaymentDetails": {
"PaymentForm": "BankTransfer",
"BankAccount": {
"BankAccountNumber": "PL27114020040000300201355387"
}
}
}'
Krok 3. Jeżeli operacja przebiegnie prawidłowo w odpowiedzi w sekcji Data znajdzie się ID Faktury Korekty (wystawionej)
{
"Data": ID_FAKTURY_KOREKTA,
"Status": 0,
"Message": "OK",
"ErrorCode": null,
"AdditionalData": NUMER_FAKTURY_KOREKTA
}
Scenariusz 4: Wystawienie korekty do istniejącej korekty w Taxxo
Jeżeli transakcja sprzedaży wymaga wielokrotnej modyfikacji istnieje możliwość wystawienia korekty do już istniejącej w systemie Taxxo faktury korygującej.
Aby wystawić taką korektę należy postępować zgodnie z odpowiednim Scenariuszem 1, 2 lub 3 wskazując jako ID Faktury Korygowanej identyfikator istniejącej już korekty w Taxxo.
Scenariusz 5: Wystawienie korekty do faktury w Taxxo – korekta do zera
Scenariusz opisuje wystawienie korekty faktury „do zera” np. gdy klient zrezygnował z transakcji.
Krok 1. Stwórz opis korekty w formacie JSON z minimalną wymaganą ilością informacji zgodnie z dokumentacją https://platforma2.taxxo.pl/api/documentation/#!/Invoices/ApiPublicInvoiceByInvoiceIdCorrectionToZeroPost
Nieuzupełnione dane korekty zostaną przepisane z faktury korygowanej.
Krok 2. Tak przygotowany obiekt wyślij do metody POST /api/public/invoice/{invoiceId}/correctionToZero zastępując {invoiceId} ID Faktury, wpisując dodatkowo do nagłówka Authorization wartość otrzymanego w sekcji Przygotowanie/Krok2 Tokenu Sesji
curl --request POST \
--url https://platforma2.taxxo.pl /api/public/invoice/ID_FAKTURY/correctionToZero \
--header 'authorization: TOKEN_SESJI' \
--header 'Content-Type: application/json' \
--data '{
}'
Krok 3. Jeżeli operacja przebiegnie prawidłowo w odpowiedzi w sekcji Data znajdzie się ID Faktury Korekty (wystawionej)
{
"Data": ID_FAKTURY_KOREKTA,
"Status": 0,
"Message": "OK",
"ErrorCode": null,
"AdditionalData": NUMER_FAKTURY_KOREKTA
}
Scenariusz 6: Pobranie faktur korygujących wystawionych do faktury w Taxxo
Scenariusz opisuje sposób pobrania listy faktur korygujących wystawionych do pojedynczej faktury w Taxxo.
Krok 1. Żądanie wyślij do metody GET /api/public/invoice/{invoiceId}/corrections zastępując {invoiceId} ID Faktury, wpisując dodatkowo do nagłówka Authorization wartość otrzymanego w sekcji Przygotowanie/Krok2 Tokenu Sesji
curl --request GET \
--url https://platforma2.taxxo.pl/api/public/invoice/ID_FAKTURY/corrections \
--header 'authorization: TOKEN_SESJI' \
Krok 2. Jeżeli operacja przebiegnie prawidłowo w odpowiedzi w sekcji Data znajdzie się Lista Faktur Korygujących
{
"Data": LISTA_FAKTUR_KORYGUJĄCYCH,
"Status": 0,
"Message": "OK",
"ErrorCode": null,
"AdditionalData": null,
"IsStatusOK": true
}
Pytania i sugestie dotyczące API – api@taxxo.pl