API – Faktura proforma - Baza Wiedzy programu Comarch Betterfly

POBIERANIE FAKTUR PROFORMA

Pobieranie faktur proforma: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas

Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
PurchasingPartyId	Id kontrahenta na dokumencie
ReceivingPartyId	Id odbiorcy na dokumencie
PaymentTypeId	Id formy płatności – do pobrania z zasobu API Formy płatności
BankAccountId	Id rachunku bankowego
InvoiceType	Algorytm obliczania (0 – od netto / 1 – od brutto)
OSSProcedureCountryCode	Kod kraju dla procedury OSS – do pobrania ze słownika kodów krajów UE tutaj
IsOSSProcedure	Oznaczenie procedury OSS (true / false)
InvoiceDocIdNum	Id powiązanej faktury sprzedaży, faktury zaliczkowej lub powiązanego paragonu
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
Items	Pozycje dokumentu
$id	Numer porządkowy w ramach odpowiedzi JSON
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
ProductDescription	Opis produktu
VatRateId	Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj
Id	Id pozycji dokumentu w bazie danych
Description	Opis dokumentu
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:

[code_snippet id=5]

Przykład

Lista faktur proforma, które zostały przekształcone do faktury sprzedaży, faktury zaliczkowej lub paragonu: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas/?$filter=InvoiceDocIdNum ne null

Możliwe jest także pobranie danych na temat określonego dokumentu faktury proforma:

[GET] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas/XXX (gdzie XXX to Id dokumentu proforma w bazie danych)

Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas/2901092

Wskazówka

W API obsługiwane są faktury proforma w walucie PLN. W walucie obcej dostępne jest tylko pobieranie faktur. Nie są obsługiwane dokumenty anulowane.

DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA

Dodawanie faktury proforma: [POST] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas

Wskazówka

Faktury proforma dodawane do Comarch Betterfly poprzez API zawsze będą miały status „Zapisane”. Wszelkie dalsze przekształcenia należy wykonywać po zalogowaniu do aplikacji.

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PurchasingPartyId	Id kontrahenta na dokumencie	Tak
ReceivingPartyId	Id odbiorcy na dokumencie	Nie
PaymentTypeId	Id formy płatności	Tak
BankAccountId	Id rachunku bankowego	Nie
InvoiceType	Algorytm obliczania (0 – od netto / 1 – od brutto)	Nie¹
OSSProcedureCountryCode	Kod kraju dla procedury VAT OSS	Nie⁴
IsOSSProcedure	Oznaczenie procedury VAT OSS	Nie
Items	Pozycje dokumentu	Nie²
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
VatRateId	Id stawki VAT	Nie⁴
Description	Opis dokumentu	Nie
IssueDate	Data wystawienia dokumentu	Nie³

1) W przypadku braku oznaczenia algorytmu, domyślnie zostanie zastosowane obliczenie od netto.

2) 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.

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

4) Parametry należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”.

Przykładowe zapytanie JSON:

[code_snippet id=13 format]

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury proforma.

EDYCJA FAKTURY PROFORMA

Edycja faktury proforma: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PurchasingPartyId	Id kontrahenta na dokumencie	Tak
ReceivingPartyId	Id odbiorcy na dokumencie	Nie
PaymentTypeId	Id formy płatności	Tak
BankAccountId	Id rachunku bankowego	Nie
InvoiceType	Algorytm obliczania (0 – od netto / 1 – od brutto)	Nie
OSSProcedureCountryCode	Kod kraju dla procedury VAT OSS	Nie³
IsOSSProcedure	Oznaczenie procedury VAT OSS	Nie
Items	Pozycje dokumentu	Nie¹
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
VatRateId	Id stawki VAT	Nie³
Id	Id pozycji dokumentu w bazie danych	Nie²
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 pominięcia numeru Id pozycji podczas operacji edycji, zostanie dodana kolejna pozycja do dokumentu ze wskazanymi parametrami.

3) Parametry należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”.

Uwaga

W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.

Uwaga

Poprzez Comarch Betterfly API można edytować jednie faktury bez przekształceń (Status = 0).

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

Przykładowe zapytanie JSON (zmiana ilości sztuk na proformie o Id=28964885):

[code_snippet id=14 format]

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

USUWANIE FAKTURY PROFORMA

Usuwanie faktury proforma: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.4/proformas/XXX (gdzie XXX to Id dokumentu faktury proforma w bazie danych)

Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/proformas/2901094

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

Wskazówka

Opcja usuwania faktury proforma jest dostępna tylko dla dokumentów bez przekształceń.

Aby dowiedzieć się jak pobrać poprzez API wydruk faktury proforma: API – Wydruki.