Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/profitmargininvoices
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo) |
|
PurchasingPartyId
|
Id nabywcy na dokumencie |
|
PurchasingParty
|
Dane nabywcy na dokumencie (CustomerType: 0 – osoba fizyczna, 1 – podmiot gospodarczy) |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie |
|
ReceivingParty
|
Dane odbiorcy na dokumencie (CustomerType: 0 – osoba fizyczna, 1 – podmiot gospodarczy) |
|
PaymentTypeId
|
Id formy płatności – do pobrania z zasobu API Formy płatności |
|
PaymentType
|
Typ płatności (0 – płatność gotówką, 1- płatność na konto, 2 – płatność kartą) |
|
PaymentDeadline
|
Termin płatności |
|
BankAccountId
|
Id rachunku bankowego |
|
BankAccountNumber
|
Numer rachunku bankowego |
|
SalesDate
|
Data sprzedaży |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) |
|
ProfitMarginInvoiceProcedureType
|
Rodzaj procedury VAT marża wg poniższego klucza: 0 – Brak 1 – Procedura marży dla biur podróży 2 – Procedura marży – towary używane 3 – Procedura marży – dzieła sztuki 4 – Procedura marży – przedmioty kolekcjonerskie i antyki |
|
ProfitMarginTotal
|
Wartość marży dla całego dokumentu |
|
GrossTotal
|
Wartość brutto dla całego dokumentu |
|
CurrencyGrossTotal
|
Wartość brutto dla całego dokumentu, w walucie dokumentu |
|
CurrencyCode
|
Symbol waluty dokumentu |
|
CurrencyRateType
|
Typ kursu: 0 – Średni kurs NBP, 1 – kurs ręczny |
|
CurrencyRateDate
|
Data kursu waluty |
|
CurrencyConverter
|
Mianownik kursu walutowego |
|
CurrencyRate
|
Licznik kursu walutowego |
|
KSeFData
|
Dane dokumentu związane z KSeF |
|
TaskStatus
|
Status przetwarzania dokumentu 0 – zadanie nigdy nie było uruchomione na tym dokumencie (domyślny status dla wszystkich dokumentów) 1 – zadanie zostało uruchomione 2 – zadanie jest w trakcie 3 – trwa wysyłanie do KSeF 4 – trwa pobieranie UPO 5 – trwa wysyłanie dokumentu za pomocą IWD 6 – zadanie zostało przerwane 7 – zadanie się zakończyło 8 – trwa księgowanie 9 – zadanie nie zostało uruchomione ze względu na niespełnienie warunków początkowych |
|
InvoiceStatus
|
Status dokumentu wysłanego do Krajowego Systemu e-Faktur 0 – nie wysłano, 1 – wysłano (można teraz pobrać UPO) 2 – odrzucono 3 – pobrano UPO 4 – tryb awaryjny |
|
DocumentNumber
|
Numer dokumentu KSeF |
|
UPOReceiveDate
|
Data odebrania UPO |
| Items | Pozycje dokumentu |
| ProductId | Id produktu |
| Quantity | Ilość |
| ProductCurrencyPrice | Cena sprzedaży, po rabacie w walucie dokumentu, jeżeli InvoiceType = 0 – Cena sprzedaży netto w walucie dokumentu, jeżeli InvoiceType = 1 – Cena sprzedaży brutto w walucie dokumentu |
| ProductPrice | Cena sprzedaży, po rabacie jeżeli InvoiceType = 0 – Cena sprzedaży netto, jeżeli InvoiceType = 1 – Cena sprzedaży brutto |
| ProductName | Nazwa produktu |
|
ProductDescription
|
Opis produktu |
|
UnitOfMeasurement
|
Jednostka miary |
|
VatRateId
|
Id stawki VAT – do pobrania ze słownika stawek VAT tutaj |
| ProfitMarginVatRateId | Id stawki VAT dla kwoty marży – do pobrania ze słownika stawek VAT |
| ProductProfitMarginValue | Kwota marży dla produktu |
| 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:
[code_snippet id=63]
Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury VAT marża:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.5/profitmargininvoices/XXX (gdzie XXX to Id faktury VAT marża w bazie danych)
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/profitmargininvoices/2901096
Aby dowiedzieć się jak pobrać poprzez API wydruk faktury proforma: API – Wydruki