Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
|
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 opisanym w artykule API Procedura OSS |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) |
|
IsFinal
|
Oznaczenie typu faktury (true / false) |
|
PaymentId
|
Id płatności |
|
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 |
|
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) |
|
NetTotal
|
Wartość netto dla całego dokumentu |
|
CurrencyNetTotal
|
Wartość netto w walucie obcej dla całego dokumentu |
|
GrossTotal
|
Wartość brutto dla całego dokumentu |
|
CurrencyGrossTotal
|
Wartość brutto w walucie obcej dla całego dokumentu |
|
VatTotal
|
Wartość VAT dla całego dokumentu |
|
CurrencyVatTotal
|
Wartość VAT w walucie obcej dla całego 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 |
|
DocumentCreatedByTaxPayer
|
Dokument utworzony przez: true – Płatnika VAT false – Podatnika zwolnionego z VAT |
| 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 jeżeli InvoiceType = 1 – Cena sprzedaży brutto |
| 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 opisanym w artykule API Procedura 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:
[code_snippet id=61]
Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury sprzedaży:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/XXX (gdzie XXX to Id faktury sprzedaży w bazie danych)
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/2901096
Dostępna jest możliwość pobrania dokumentu o konkretnym numerze:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/invoices?number={number}
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices?number=FS/21/7/1
Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices
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. 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 Betterfly. W przypadku braku oznaczenia statusu płatności, domyślnie dokument zostanie oznaczony jako brak zapłaty (0). |
| OSSProcedureCountryCode | Kod kraju dla procedury OSS | Nie. Parametr należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”. |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) | Nie |
|
PurchasingPartyId
|
Id nabywcy na dokumencie | Tak |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie | Nie |
|
PaymentTypeId
|
Id formy płatności | Tak |
|
PaymentDeadline
|
Termin płatności | Nie |
|
BankAccountId
|
Id rachunku bankowego | Nie |
|
SalesDate
|
Data sprzedaży | Nie. W przypadku braku daty w parametrach, ustawiana będzie data bieżąca. |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) | Nie. W przypadku braku wartości w tym polu, zostanie zastosowany algorytm od netto. |
| Items | Pozycje dokumentu | Nie. 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. Wystawienie faktury z produktem bez karty towarowej jest dostępne jedynie z poziomu aplikacji Comarch Betterfly. |
| ProductId | Id produktu | Tak |
| Quantity | Ilość | Tak |
| ProductCurrencyPrice | Cena sprzedaży | Tak |
|
ProductDescription
|
Opis produktu | Nie |
|
VatRateId
|
Id stawki VAT | Nie. Parametr należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”. |
| Description | Opis dokumentu | Nie |
| IssueDate | Data wystawienia dokumentu | Nie. W przypadku braku daty w parametrach, ustawiana będzie data bieżąca. |
Przykładowe zapytanie JSON:
[code_snippet id=15]
W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży.
Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices
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 nabywcy na dokumencie | Tak |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie | Nie |
|
PaymentTypeId
|
Id formy płatności | Tak |
|
PaymentDeadline
|
Termin płatności | Nie |
|
BankAccountId
|
Id rachunku bankowego | Nie |
|
SalesDate
|
Data sprzedaży | Nie |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) | Nie. W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu. Dla faktur finalnych nie ma możliwości zmiany algorytmu. |
| Items | Pozycje dokumentu | Nie, jeśli edytowana faktura zawiera pozycje. |
| 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 | Nie. W przypadku pominięcia numeru Id pozycji podczas operacji edycji, zostanie dodana kolejna pozycja do dokumentu ze wskazanymi parametrami. |
| Description | Opis dokumentu | Nie |
| IssueDate | Data wystawienia dokumentu | Nie |
| Id | Id dokumentu w bazie danych | Tak |
W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi.
Przykładowe zapytanie JSON (zmiana ilości sztuk i ceny na fakturze o Id=28964885):
[code_snippet id=16]
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
Zatwierdzanie faktur sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/confirm
W odpowiedzi zostanie wysłany status i JSON odpowiedzi.
Przykładowe zapytanie JSON:
[code_snippet id=17]
Przykładowa odpowiedź JSON:
[code_snippet id=18]
Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/XXX (gdzie XXX to Id dokumentu faktury w bazie danych)
Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/2901095
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
Aby dowiedzieć się jak poprzez interface API pobrać wydruk faktury: API – Wydruki.