API – Faktura sprzedaży

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.erpxt.pl/api2/public/invoices

Opis struktury JSON odpowiedzi:

Parametr Opis
$id Numer porządkowy w ramach odpowiedzi JSON
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo)
PurchasingPartyId
Id kontrahenta na dokumencie
PaymentTypeId
Id formy płatności
BankAccountId
Id rachunku bankowego
SalesDate Data sprzedaży
Items Pozycje dokumentu
       $id Numer porządkowy w ramach odpowiedzi JSON
       ProductId Id produktu
       Quantity Ilość
       ProductCurrencyNetPrice Cena netto sprzedaży
       ProductDescription
Opis produktu
       Id ID pozycji dokumentu w bazie danych
IssueDate Data wystawienia dokumentu
Number Numer dokumentu
Status Status dokumentu (0 – dokument w buforze / 1 – dokument zatwierdzony na stałe)
Id ID dokumentu w bazie danych

Przykładowa odpowiedź JSON:

Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury sprzedaży:

[GET] https://app.erpxt.pl/api2/public/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych)

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/invoices/11

Przykładowa odpowiedź JSON:

Wskazówka
W API obsługiwane są faktury sprzedaży w buforze. Dodatkowo można pobrać dane i wydruki dla faktur zatwierdzonych na stałe. Nie są obsługiwane faktury zaliczkowe, faktury finalne, dokumenty anulowane oraz korekty.
Wskazówka
W API obsługiwane są faktury w walucie PLN. Nie są obsługiwane faktury w walutach obcych.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.erpxt.pl/api2/public/invoices

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie)1 Nie1
PurchasingPartyId Id kontrahenta na dokumencie Tak
PaymentTypeId Id formy płatności Tak
BankAccountId Id rachunku bankowego Nie
SalesDate Data sprzedaży w formacie RRRR-MM-DD Nie2
Items Pozycje dokumentu Nie3
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductCurrencyNetPrice
Cena netto sprzedaży Tak
       ProductDescription
Opis produktu Nie
IssueDate Data wystawienia dokumentu w formacie RRRR-MM-DD Nie2

1) Status zapłaty podczas dodawania faktury sprzedaży może przyjmować jedynie wartość: 0 – niezapłacona lub wartość: 1 – zapłacona całkowicie. Status 2 – zapłacona częściowo jest możliwy do odnotowania jedynie z poziomu aplikacji Comarch ERP XT. W przypadku braku oznaczenia statusu płatności, domyślnie dokument zostanie oznaczony jako brak zapłaty (0).

2) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca.

3) Można wystawić dokument bez dodanych pozycji. Jeśli jednak Użytkownik zdecyduje się użyć sekcji „Items”, wówczas należy wypełnić pola obowiązkowe.

Przykładowe zapytanie JSON:

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży.

Przykładowa odpowiedź:

Wskazówka
Podczas dodawania nowej faktury sprzedaży poprzez API, dokument będzie miał nadany numer zgodnie z domyślnym schematem numeracji, ustawionym w Comarch ERP XT.
Wskazówka
Faktury sprzedaży dodawane do Comarch ERP XT poprzez API zawsze będą miały status „Zapisane” (w buforze). Wszelkie dalsze operacje – np. zatwierdzenia i księgowania dokumentu – należy wykonywać po zalogowaniu do aplikacji.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.erpxt.pl/api2/public/invoices

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie) Tak
PurchasingPartyId Id kontrahenta na dokumencie Tak
PaymentTypeId Id formy płatności Tak
BankAccountId Id rachunku bankowego Nie
SalesDate Data sprzedaży w formacie RRRR-MM-DD Nie
Items Pozycje dokumentu Tak1
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductCurrencyNetPrice
Cena netto sprzedaży Tak
       ProductDescription
Opis produktu Nie
       Id
ID pozycji dokumentu w bazie danych Nie2
IssueDate Data wystawienia dokumentu w formacie RRRR-MM-DD Nie
Id Id dokumentu w bazie danych Tak

1) Jeśli edytowana faktura zawiera pozycje.

2) W przypadku pominięcia numeru Id pozycji podczas operacji edycji, zostanie dodana kolejna pozycja do dokumentu ze wskazanymi parametrami.

Uwaga
W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.
Uwaga
Poprzez API można edytować jednie faktury zapisane do bufora.

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi.

Przykładowe zapytanie JSON (zmiana formy płatności i ilości sztuk produktów):

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:

Przyklad

Usuwanie pozycji z faktury sprzedaży poprzez edycję dokumentu: [PUT] https://app.erpxt.pl/api2/public/invoices

Przykładowe zapytanie:

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:

Uwaga
Opcja edycji faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.erpxt.pl/api2/public/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych)

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/invoices/12

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:

Uwaga
Opcja usuwania faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

 

Aby dowiedzieć się jak pobrać wydruk faktury sprzedaży poprzez API – kliknij tutaj.

 

Czy ten artykuł był pomocny?