POBIERANIE FAKTUR ZALICZKOWYCH
Pobieranie faktur zaliczkowych: [GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices
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) |
| OSSProcedureCountryCode | Kod kraju dla procedury OSS – do pobrania ze słownika kodów krajów UE tutaj |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) |
|
PurchasingPartyId
|
Id kontrahenta na dokumencie |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie |
|
PaymentTypeId
|
Id formy płatności |
|
BankAccountId
|
Id rachunku bankowego |
|
SalesDate
|
Data sprzedaży |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) |
| Items | Pozycje dokumentu |
| $id | Numer porządkowy w ramach odpowiedzi JSON |
|
CurrencyAdvance
|
Wartość zaliczki |
| ProductId | Id produktu |
| Quantity | Ilość |
| ProductCurrencyPrice | Cena sprzedaży |
|
ProductDescription
|
Opis produktu |
|
VatRateId
|
Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj, pole jest powiązane z procedurą OSS |
| Id | Id pozycji dokumentu w bazie danych |
| Description | Opis dokumentu |
| 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:
Przykładowa odpowiedź JSON dla faktury w procedurze VAT OSS:
Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury zaliczkowej:
[GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/XXX (gdzie XXX to id faktury zaliczkowej w bazie danych)
Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/2901096
Dostępna jest możliwość pobrania dokumentu o konkretnym numerze:
[GET] https://app.erpxt.pl/api2/public/v1.1/advanceInvoices/invoices?number={number}
Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices?number=FAZAL/2022/8
DODAWANIE NOWEGO DOKUMENTU FAKTURY ZALICZKOWEJ
Dodawanie faktury zaliczkowej: [POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo) | Nie1 |
| OSSProcedureCountryCode | Kod kraju dla procedury OSS | Nie6 |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) | Nie |
|
PurchasingPartyId
|
Id kontrahenta na dokumencie | Tak |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie | Nie |
|
PaymentTypeId
|
Id formy płatności | Tak |
|
BankAccountId
|
Id rachunku bankowego | Nie |
|
SalesDate
|
Data sprzedaży | Nie2 |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) | Nie3 |
| Items | Pozycje dokumentu | Nie4 |
|
CurrencyAdvance
|
Wartość zaliczki | Nie7 |
| ProductId | Id produktu | Tak |
| Quantity | Ilość | Tak |
| ProductCurrencyPrice | Cena sprzedaży | Tak |
|
ProductDescription
|
Opis produktu | Nie |
| VatRateId | Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj, pole jest powiązane z procedurą OSS | Nie6 |
| Description | Opis dokumentu | Nie |
| IssueDate | Data wystawienia dokumentu | Nie5 |
1) Status zapłaty podczas dodawania faktury zaliczkowej 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) W przypadku braku wartości w tym polu, zostanie zastosowany algorytm od netto.
4) 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.
5) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca.
6) Parametry należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”.
7) W przypadku braku uzupełnienia tego pola dokument zostanie wystawiony z zerową zaliczką
Przykładowe zapytanie JSON:
W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury zaliczkowej.
DODAWANIE POWIĄZANEJ FAKTURY ZALICZKOWEJ
Dodawanie powiązanej faktury zaliczkowej: [POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices?advanceId={id}
Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices?advanceId=3006043
W odpowiedzi zostanie wysłane ID nowej powiązanej faktury zaliczkowej. Faktura będzie zapisana do bufora oraz wartość zaliczki będzie wynosić zero PLN.
W przypadku podania w zapytaniu błędnego id, w odpowiedzi JSON, mogą pojawić się następujące komunikaty:
ErrorCode 1 – kontrahent jest zanonimizowany
ErrorCode 2 – dokument nie jest fakturą zaliczkową
ErrorCode 3 – dokument posiada korektę w buforze
ErrorCode 4 – dokument jest anulowany
ErrorCode 5 – dokument jest w buforze
ErrorCode 6 – dokument jest korektą faktury zaliczkowej
ErrorCode 7 – dokument już został przekształcony do finalnej
ErrorCode 8 – dokument nie jest możliwy do przekształcenia (wystawiony przed 2019 rokiem)
ErrorCode 9 – dokument jest fakturą finalną
Przykładowa odpowiedź JSON:
EDYCJA FAKTURY ZALICZKOWEJ
Edycja faktury sprzedaży: [PUT] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo) | Nie |
| OSSProcedureCountryCode | Kod kraju dla procedury VAT OSS – do pobrania ze słownika kodów krajów UE tutaj | Nie |
| IsOSSProcedure | Oznaczenie procedury VAT OSS (true / false) | Nie |
|
PurchasingPartyId
|
Id kontrahenta na dokumencie | Tak |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie | Nie |
|
PaymentTypeId
|
Id formy płatności | Tak |
|
BankAccountId
|
Id rachunku bankowego | Nie |
|
SalesDate
|
Data sprzedaży | Nie |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) | Nie2 |
| Items | Pozycje dokumentu | Nie1 |
|
CurrencyAdvance
|
Wartość zaliczki | Nie2 |
| ProductId | Id produktu | Tak |
| Quantity | Ilość | Tak |
| ProductCurrencyPrice | Cena sprzedaży | Tak |
|
ProductDescription
|
Opis produktu | Nie |
|
VatRateId
|
Id stawki VAT – do pobrania ze słownika stawek VAT tutaj, pole jest powiązane z procedurą VAT OSS | Nie |
| Id | Id pozycji dokumentu w bazie danych | Nie3 |
| Description | Opis dokumentu | Nie |
| IssueDate | Data wystawienia dokumentu | Nie |
| Id | Id dokumentu w bazie danych | Tak |
1) Jeśli edytowana faktura zawiera pozycje.
2) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu
3) 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 kwoty zaliczki na fakturze o Id=2994705):
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
ZATWIERDZANIE FAKTUR ZALICZKOWYCH
Zatwierdzanie faktur zaliczkowych: [PUT] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/confirm
W odpowiedzi zostanie wysłany status i JSON odpowiedzi.
Przykładowe zapytanie JSON:
Przykładowa odpowiedź JSON:
USUWANIE FAKTURY ZALICZKOWEJ
Usuwanie faktury sprzedaży: [DEL] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/XXX (gdzie XXX to Id dokumentu faktury zaliczkowej w bazie danych)
Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/2901095
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
