POBIERANIE FAKTUR PROFORMA
Pobieranie faktur proforma: [GET] https://app.erpxt.pl/api2/public/proformas
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
| $id | Numer porządkowy w ramach odpowiedzi JSON |
|
PurchasingPartyId
|
Id kontrahenta na dokumencie |
|
PaymentTypeId
|
Id formy płatności |
|
BankAccountId
|
Id rachunku bankowego |
|
InvoiceDocIdNum
|
Id powiązanej faktury sprzedaży, faktury zaliczkowej lub powiązanego paragonu |
| 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 – nieprzekształcony bezpośrednio do dokumentu sprzedażowego, 1 – przekształcony do faktury sprzedaży, faktury zaliczkowej lub paragonu |
| Id | ID dokumentu w bazie danych |
Przykładowa odpowiedź JSON:
Możliwe jest także pobranie danych na temat określonego dokumentu faktury proforma:
[GET] https://app.erpxt.pl/api2/public/proformas/XXX (gdzie XXX to Id dokumentu proforma w bazie danych)
Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/proformas/12
Przykładowa odpowiedź JSON:
DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA
Dodawanie faktury proforma: [POST] https://app.erpxt.pl/api2/public/proformas
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
| PurchasingPartyId | Id kontrahenta na dokumencie | Tak |
| PaymentTypeId | Id formy płatności | Tak |
| BankAccountId | Id rachunku bankowego | Nie |
| Items | Pozycje dokumentu | Nie1 |
| 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) 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.
2) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca.
Przykładowe zapytanie JSON:
W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury proforma.
Przykładowa odpowiedź:
EDYCJA FAKTURY PROFORMA
Edycja faktury proforma: [PUT] https://app.erpxt.pl/api2/public/proformas
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
| PurchasingPartyId | Id kontrahenta na dokumencie | Tak |
| PaymentTypeId | Id formy płatności | Tak |
| BankAccountId | Id rachunku bankowego | 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.
W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi.
Przykładowe zapytanie JSON (zmiana formy płatności na proformie o Id=13):
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:
USUWANIE FAKTURY PROFORMA
Usuwanie faktury proforma: [DEL] https://app.erpxt.pl/api2/public/proformas/XXX (gdzie XXX to Id dokumentu faktury proforma w bazie danych)
Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/proformas/14
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem:
