POBIERANIE FAKTUR PROFORMA

Pobieranie faktur proforma: [GET] https://app.comarchbetterfly.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:

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/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/proformas/XXX (gdzie XXX to Id dokumentu proforma w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/proformas/12 Przykładowa odpowiedź JSON:

DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA

Dodawanie faktury proforma: [POST] https://app.comarchbetterfly.pl/api2/public/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
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.comarchbetterfly.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.

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 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.comarchbetterfly.pl/api2/public/proformas/XXX (gdzie XXX to Id dokumentu faktury proforma w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/proformas/14 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ć wydruk faktury proforma poprzez API - kliknij tutaj.    

POBIERANIE FAKTUR PROFORMA

Pobieranie faktur proforma: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/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
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
Items	Pozycje dokumentu
$id	Numer porządkowy w ramach odpowiedzi JSON
ProductId	Id produktu
Quantity	Ilość
ProductCurrencyPrice	Cena netto 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 – 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:

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/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.2/proformas/XXX (gdzie XXX to Id dokumentu proforma w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/proformas/2901092

DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA

Dodawanie faktury proforma: [POST] https://app.comarchbetterfly.pl/api2/public/v1.2/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)	Nie1
OSSProcedureCountryCode	Kod kraju dla procedury VAT OSS	Nie4
IsOSSProcedure	Oznaczenie procedury VAT OSS	Nie
Items	Pozycje dokumentu	Nie2
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
VatRateId	Id stawki VAT	Nie4
Description	Opis dokumentu	Nie
IssueDate	Data wystawienia dokumentu	Nie3

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: W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury proforma.

EDYCJA FAKTURY PROFORMA

Edycja faktury proforma: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.2/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	Nie3
IsOSSProcedure	Oznaczenie procedury VAT OSS	Nie
Items	Pozycje dokumentu	Nie1
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
VatRateId	Id stawki VAT	Nie3
Id	Id pozycji dokumentu w bazie danych	Nie2
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 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=2901094): 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/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ć wydruk faktury proforma poprzez API - kliknij tutaj.    

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/invoices 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)
PurchasingPartyId	Id kontrahenta na dokumencie
PaymentTypeId	Id formy płatności
BankAccountId	Id rachunku bankowego
SalesDate	Data sprzedaży
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 - dokument w buforze / 1 - dokument zatwierdzony na stałe)
Id	ID dokumentu w bazie danych

Przykładowa odpowiedź JSON: Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/invoices/11 Przykładowa odpowiedź JSON:

Wskazówka

W Comarch Betterfly API obsługiwane są faktury sprzedaży w buforze. Dodatkowo można pobrać dane i wydruki dla faktur zatwierdzonych na stałe. Nie są obsługiwane faktury zaliczkowe, faktury finalne, dokumenty anulowane oraz korekty.

Wskazówka

W ERP API obsługiwane są faktury w walucie PLN. Nie są obsługiwane faktury w walutach obcych.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/invoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 - niezapłacona, 1 - zapłacona całkowicie)1	Nie1
PurchasingPartyId	Id kontrahenta na dokumencie	Tak
PaymentTypeId	Id formy płatności	Tak
BankAccountId	Id rachunku bankowego	Nie
SalesDate	Data sprzedaży w formacie RRRR-MM-DD	Nie2
Items	Pozycje dokumentu	Nie3
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) 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). 2) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca. 3) 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. Przykładowe zapytanie JSON: W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży. Przykładowa odpowiedź:

Wskazówka

Podczas dodawania nowej faktury sprzedaży poprzez API, dokument będzie miał nadany numer zgodnie z domyślnym schematem numeracji, ustawionym w Comarch Betterfly.

Wskazówka

Faktury sprzedaży dodawane do Comarch Betterfly poprzez API zawsze będą miały status "Zapisane" (w buforze). Wszelkie dalsze operacje - np. zatwierdzenia i księgowania dokumentu - należy wykonywać po zalogowaniu do aplikacji.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/invoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 - niezapłacona, 1 - zapłacona całkowicie)	Tak
PurchasingPartyId	Id kontrahenta na dokumencie	Tak
PaymentTypeId	Id formy płatności	Tak
BankAccountId	Id rachunku bankowego	Nie
SalesDate	Data sprzedaży w formacie RRRR-MM-DD	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.

Uwaga

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

Uwaga

Poprzez API można edytować jednie faktury zapisane do bufora.

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zmiana formy płatności i ilości sztuk produktów): Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

Przykład

Usuwanie pozycji z faktury sprzedaży poprzez edycję dokumentu: [PUT] https://app.comarchbetterfly.pl/api2/public/invoices Przykładowe zapytanie: Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

Uwaga

Opcja edycji faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/invoices/12 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

Uwaga

Opcja usuwania faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury sprzedaży poprzez API - kliknij tutaj.  

Wskazówka

Poniższe metody dotyczą faktur sprzedaży i faktur finalnych

 

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices 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)
IsFinal	Oznaczenie typu faktury  (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
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 sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices/XXX (gdzie XXX to Id faktury sprzedaży w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices/2901096   Dostępna jest możliwość pobrania dokumentu o konkretnym numerze: [GET] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices/invoices?number={number} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices?number=FS/21/7/1

Wskazówka

W Comarch Betterfly API obsługiwane są faktury sprzedaży w walucie PLN. Nie są obsługiwane faktury w walutach obcych, anulowane oraz korekty.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/v1.2/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)	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
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena sprzedaży	Tak
ProductDescription	Opis produktu	Nie
VatRateId	Id stawki VAT	Nie6
Description	Opis dokumentu	Nie
IssueDate	Data wystawienia dokumentu	Nie5

1) 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). 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".   Przykładowe zapytanie JSON: W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.2/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 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, 4
Items	Pozycje dokumentu	Nie1
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. 4) Dla faktur finalnych nie ma możliwości zmiany algorytmu.

Uwaga

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

Uwaga

Poprzez API można edytować jednie faktury zapisane do bufora.

  W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zmiana ilości sztuk i ceny na fakturze o Id=2901095): Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.  

ZATWIERDZANIE FAKTUR SPRZEDAŻY

Zatwierdzanie faktur sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Wskazówka

Metoda zatwierdza jedynie faktury sprzedaży. Korekty do tych dokumentów należy zatwierdzić w aplikacji.

Przykładowe zapytanie JSON: Przykładowa odpowiedź JSON:

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices/XXX (gdzie XXX to Id dokumentu faktury w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.2/invoices/2901095 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktur sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury poprzez API - kliknij tutaj.  

Wskazówka

Poniższe metody dotyczą faktur sprzedaży i faktur finalnych

 

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices 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)
IsFinal	Oznaczenie typu faktury  (true / false)
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
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
GrossTotal	Wartość brutto dla całego dokumentu
VatTotal	Wartość VAT dla całego dokumentu
Items	Pozycje dokumentu
$id	Numer porządkowy w ramach odpowiedzi JSON
ProductId	Id produktu
Quantity	Ilość
ProductCurrencyPrice	Cena sprzedaży
ProductName	Nazwa produktu
ProductDescription	Opis produktu
UnitOfMeasurement	Jednostka miary
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:   Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/XXX (gdzie XXX to Id faktury sprzedaży w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/2901096   Dostępna jest możliwość pobrania dokumentu o konkretnym numerze: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/invoices?number={number} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices?number=FS/21/7/1

Wskazówka

W API obsługiwane są faktury sprzedaży w walucie PLN. Nie są obsługiwane faktury w walutach obcych, oraz dokumenty anulowane. Faktury zaliczkowe oraz korekty są obsługiwane w innych metodach.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/v1.3/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: W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/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

 

Uwaga

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

Uwaga

Poprzez API można edytować jednie faktury zapisane do bufora.

  W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zmiana ilości sztuk i ceny na fakturze o Id=2901095): Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.  

ZATWIERDZANIE FAKTUR SPRZEDAŻY

Zatwierdzanie faktur sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Wskazówka

Metoda zatwierdza jedynie faktury sprzedaży. Korekty do tych dokumentów należy zatwierdzić oddzielną metodą.

Przykładowe zapytanie JSON: Przykładowa odpowiedź JSON:

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/XXX (gdzie XXX to Id dokumentu faktury w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/invoices/2901095 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktur sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury poprzez API - kliknij tutaj.  

Wskazówka

Poniższe metody dotyczą faktur sprzedaży i faktur finalnych

 

POBIERANIE FAKTUR SPRZEDAŻY

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

Wskazówka

W API obsługiwane są faktury sprzedaży w walucie PLN. W walucie obcej dostępne jest tylko pobieranie faktur. Nie są obsługiwane dokumenty anulowane. Faktury zaliczkowe oraz korekty są obsługiwane w osobnych metodach.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

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

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

 

Uwaga

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

Uwaga

Poprzez API można edytować jednie faktury zapisane do bufora.

  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

Zatwierdzanie faktur sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/invoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Wskazówka

Metoda zatwierdza jedynie faktury sprzedaży. Korekty do tych dokumentów należy zatwierdzić oddzielną metodą.

Przykładowe zapytanie JSON: [code_snippet id=17] Przykładowa odpowiedź JSON: [code_snippet id=18]

USUWANIE FAKTURY SPRZEDAŻY

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.

Wskazówka

Opcja usuwania faktur sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

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

POBIERANIE FAKTUR ZALICZKOWYCH

Pobieranie faktur zaliczkowych: [GET] https://app.comarchbetterfly.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.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices/XXX (gdzie XXX to id faktury zaliczkowej w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices/2901096   Dostępna jest możliwość pobrania dokumentu o konkretnym numerze: [GET] https://app.comarchbetterfly.pl/api2/public/v1.1/advanceInvoices/invoices?number={number} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices?number=FAZAL/2022/8  

Wskazówka

W Comarch Betterfly API obsługiwane są faktury zaliczkowe w walucie PLN. Nie są obsługiwane faktury w walutach obcych, anulowane oraz korekty.

DODAWANIE NOWEGO DOKUMENTU FAKTURY ZALICZKOWEJ

Dodawanie faktury zaliczkowej: [POST] https://app.comarchbetterfly.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 Betterfly. 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.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices?advanceId={id} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.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.comarchbetterfly.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.

Uwaga

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

Uwaga

Poprzez API można edytować jednie faktury zapisane do bufora.

Wskazówka

Dedykowany schemat numeracji dla faktur zaliczkowych można utworzyć w aplikacji. W przypadku jego braku dokumenty będą dodawane ze schematem faktur sprzedaży.

  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.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Wskazówka

Metoda zatwierdza jedynie faktury zaliczkowe. Korekty do tych dokumentów należy zatwierdzić w aplikacji.

Przykładowe zapytanie JSON: Przykładowa odpowiedź JSON:

USUWANIE FAKTURY ZALICZKOWEJ

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices/XXX (gdzie XXX to Id dokumentu faktury zaliczkowej w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.2/advanceInvoices/2901095 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktury zaliczkowej jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury zaliczkowej poprzez API - kliknij tutaj.    

POBIERANIE FAKTUR ZALICZKOWYCH

Pobieranie faktur zaliczkowych: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices 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: API – Obsługa procedury OSS
IsOSSProcedure	Oznaczenie procedury OSS (true / false)
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 kontrahenta na dokumencie
ReceivingPartyId	Id odbiorcy na dokumencie
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
SalesDate	Data sprzedaży
InvoiceType	Algorytm obliczania (0 - od netto / 1 - od brutto)
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
CurrencyAdvance	Wartość zaliczki
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
UnitOfMeasurement	Jednostka miary
VatRateId	Id stawki VAT - do pobrania ze słownika unijnych stawek VAT: API – Obsługa procedury 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=62]   Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury zaliczkowej: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/XXX (gdzie XXX to id faktury zaliczkowej w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/2901096   Dostępna jest możliwość pobrania dokumentu o konkretnym numerze: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/invoices?number={number} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices?number=FAZAL/2022/8  

Wskazówka

W API obsługiwane są faktury zaliczkowe w walucie PLN. W walucie obcej dostępne jest tylko pobieranie faktur zaliczkowych. Nie są obsługiwane dokumenty anulowane. Korekty są obsługiwane w innych metodach.

DODAWANIE NOWEGO DOKUMENTU FAKTURY ZALICZKOWEJ

Dodawanie faktury zaliczkowej: [POST] https://app.comarchbetterfly.pl/api2/public/v1.5/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 Betterfly. 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: [code_snippet id=38] W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury zaliczkowej.  

DODAWANIE POWIĄZANEJ FAKTURY ZALICZKOWEJ

Dodawanie powiązanej faktury zaliczkowej: [POST] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices?advanceId={id} Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/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: [code_snippet id=39]

EDYCJA FAKTURY ZALICZKOWEJ

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/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.

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 zapisane do bufora.

Wskazówka

Dedykowany schemat numeracji dla faktur zaliczkowych można utworzyć w aplikacji. W przypadku jego braku dokumenty będą dodawane ze schematem faktur sprzedaży.

  W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zmiana kwoty zaliczki na fakturze o Id=2994705): [code_snippet id=40] Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.  

ZATWIERDZANIE FAKTUR ZALICZKOWYCH

Zatwierdzanie faktur zaliczkowych: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Wskazówka

Metoda zatwierdza jedynie faktury zaliczkowe. Korekty do tych dokumentów należy zatwierdzić w aplikacji.

[code_snippet id=41]

USUWANIE FAKTURY ZALICZKOWEJ

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/XXX (gdzie XXX to Id dokumentu faktury zaliczkowej w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/advanceInvoices/2901095 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktury zaliczkowej jest dostępna tylko dla dokumentów będących w buforze.

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

POBIERANIE KONTRAHENTÓW

Pobieranie kontrahentów: [GET] https://app.comarchbetterfly.pl/api2/public/customers Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
Name	Nazwa kontrahenta
CustomerTaxNumber	Identyfikator podatkowy NIP/PESEL - w zależności od pola CustomerType
CustomerCode	Kod kontrahenta
Mail	Adres e-mail kontrahenta
PhoneNumber	Nr telefonu kontrahenta
CustomerType	Rodzaj kontrahenta (0 – osoba fizyczna / 1 – podmiot gospodarczy)
Address	Sekcja z adresem kontrahenta
$id	Numer porządkowy w ramach odpowiedzi JSON
Street	Ulica
BuildingNumber	Numer budynku
FlatNumber	Lokal
PostalCode	Kod pocztowy
City	Poczta
Id	ID adresu w bazie danych
Id	ID kontrahenta w bazie danych

Przykładowa odpowiedź JSON: Możliwe jest także pobranie karty określonego kontrahenta. [GET] https://app.comarchbetterfly.pl/api2/public/customers/XXX (gdzie XXX to Id kontrahenta w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/customers/1

Pobranie danych kontrahenta o określonym NIP. [GET] https://app.comarchbetterfly.pl/api2/public/customers/nip/XXX (gdzie XXX to numer NIP kontrahenta) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/customers/nip/6770065406

Dostępne jest również filtrowanie listy kontrahentów:

• wg nazwy: [GET] https://app.comarchbetterfly.pl/api2/public/?$filter=Name eq {nazwa}
• wg adresu e-mail: [GET] https://app.comarchbetterfly.pl/api2/public/customers/?$filter=Mail eq {adres_email}

Wskazówka

Filtrować można z użyciem kilku kryteriów wykorzystując wspierane operatory logiczne: or, and, not oraz operatory do porównań: eq (równość), ne (nierówność), gt (większe od), ge (większe lub równe), lt (mniejsze od), le (mniejsze lub równe)

Przykład

https://app.comarchbetterfly.pl/api2/public/customers/?$filter=Name eq 'Comarch' https://app.comarhbetterfly.pl/api2/public/customers/?$filter=Mail eq 'demo@comarch.pl'

DODAWANIE NOWEGO KONTRAHENTA

Dodawanie kontrahenta: [POST] https://app.comarchbetterfly.pl/api2/public/customers Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
Name	Nazwa kontrahenta	Tak
CustomerTaxNumber	Identyfikator podatkowy NIP/PESEL	Nie
CustomerCode	Kod kontrahenta	Nie1
Mail	Adres e-mail kontrahenta	Nie
PhoneNumber	Nr telefonu kontrahenta	Nie
CustomerType	Rodzaj kontrahenta (0 – osoba fizyczna / 1 – podmiot gospodarczy)	Nie2
Address	Sekcja z adresem kontrahenta
Street	Ulica	Nie
BuildingNumber	Numer domu	Nie
FlatNumber	Lokal	Nie
PostalCode	Kod pocztowy	Nie
City	Poczta	Nie

1) W przypadku braku kodu zostanie on nadany poprzez serwer. 2) W przypadku braku rodzaju zostanie zastosowane ustawienie domyślne (podmiot gospodarczy). Przykładowe zapytanie JSON: W odpowiedzi zostanie wysłane ID dodanego kontrahenta. Przykładowa odpowiedź:

EDYCJA KONTRAHENTA

Edycja kontrahenta: [PUT] https://app.comarchbetterfly.pl/api2/public/customers Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
Name	Nazwa kontrahenta	Tak
CustomerTaxNumber	Identyfikator podatkowy NIP/PESEL	Nie
CustomerCode	Kod kontrahenta	Nie
Mail	Adres e-mail kontrahenta	Nie
PhoneNumber	Nr telefonu kontrahenta	Nie
CustomerType	Rodzaj kontrahenta (0 – osoba fizyczna / 1 – podmiot gospodarczy)	Nie
Address	Sekcja z adresem kontrahenta
Street	Ulica	Nie
BuildingNumber	Numer domu	Nie
FlatNumber	Lokal	Nie
PostalCode	Kod pocztowy	Nie
City	Poczta	Nie
Id	Id adresu	Nie
Id	Id kontrahenta	Tak

Uwaga

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

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi: Przykładowe zapytanie JSON (dodanie adresu e-mail dla kontrahenta o Id=2): Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

USUWANIE KARTY KONTRAHENTA

Usuwanie kontrahenta: [DEL] https://app.comarchbetterfly.pl/api2/public/customers/XXX (gdzie XXX to Id kontrahenta w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/customers/3 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

POBIERANIE FAKTUR KORYGUJĄCYCH

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
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
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)
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)
CorrectedId	Id dokumentu korygowanego
CorrectionReasonText	Przyczyna korekty
Items	Pozycje dokumentu
$id	Numer porządkowy w ramach odpowiedzi JSON
ProductId	Id produktu
Quantity	Ilość
ProductCurrencyPrice	Cena sprzedaży
ProductName	Nazwa produktu
ProductDescription	Opis produktu
UnitOfMeasurement	Jednostka miary
VatRateId	Id stawki VAT - do pobrania ze słownika unijnych stawek VAT tutaj, pole jest powiązane również z procedurą OSS
CorrectedId	Id pozycji korygowanej w bazie danych (pozycji na dokumencie korygowanym)
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:

DODAWANIE NOWEGO DOKUMENTU FAKTURY KORYGUJĄCEJ

Dodawanie faktury korygującej: [POST] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices?documentId=XXX (gdzie XXX to Id dokumentu faktury korygowanej w bazie danych) W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury korygującej z wartościami identycznymi jak na fakturze korygowanej. W kolejnym kroku należy przy wykorzystaniu metody [PUT] nanieść odpowiednie modyfikacje wynikające z procesu korygowania dokumentu.

EDYCJA FAKTURY KORYGUJĄCEJ

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie)	Nie
PaymentTypeId	Id formy płatności	Tak
PaymentDeadline	Termin płatności	Nie
BankAccountId	Id rachunku bankowego	Nie
SalesDate	Data sprzedaży	Nie
Items	Pozycje dokumentu	Nie, chyba że korekta dotyczy pozycji (korygowana jest ilość, cena netto stawka VAT lub opis) - wtedy należy podać wszystkie poniższe parametry
ProductId	Id produktu	Nie, jw.
Quantity	Ilość	Nie, jw.
ProductCurrencyPrice	Cena sprzedaży	Nie, jw.
ProductDescription	Opis produktu	Nie, jw.
VatRateId	Id stawki VAT - do pobrania ze słownika stawek VAT tutaj	Nie, jw.
Id	Id pozycji dokumentu w bazie danych	Nie, jw.
Description	Opis dokumentu	Nie
CorrectionReasonText	Przyczyna korekty	Nie
IsOSSProcedure	Oznaczenie procedury OSS (true / false)	Nie
IssueDate	Data wystawienia dokumentu	Nie
Id	Id dokumentu w bazie danych	Tak

Uwaga

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

Uwaga

Poprzez interfejs API można edytować jednie faktury zapisane do bufora.

  W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zwrot towaru, faktura korygująca o Id=23323962): Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

ZATWIERDZANIE FAKTUR KORYGUJĄCYCH

Zatwierdzanie faktur korygujących: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi. Przykładowe zapytanie JSON: Przykładowa odpowiedź JSON:

USUWANIE FAKTURY KORYGUJĄCYCH

Usuwanie faktury korygującej: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/XXX (gdzie XXX to Id dokumentu faktury korygującej w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/23324066 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktur korygujących jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury korygującej poprzez API - kliknij tutaj.  

KOREKTY DO FAKTUR ZALICZKOWYCH

W przypadku dokumentów korygujących do faktur zaliczkowych należy skorzystać z analogicznych metod jak opisane powyżej dla faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices [POST] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices?documentId=XXX [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices/confirm [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices/XXX

Wskazówka

W przypadku faktur zaliczkowych dodatkowo zwracane jest pole dotyczące zaliczki: "CurrencyAdvance". Pole jest możliwe do edycji. W odróżnieniu od korekt do faktur sprzedaży, w przypadku korekt do faktur zaliczkowych nie można edytować ilości, ceny oraz stawki VAT produktów.

 

POBIERANIE FAKTUR KORYGUJĄCYCH

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
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)
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)
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
CorrectedId	Id dokumentu korygowanego
CorrectionReasonText	Przyczyna korekty
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 unijnych stawek VAT tutaj
CorrectedId	Id pozycji korygowanej w bazie danych (pozycji na dokumencie korygowanym)
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=8]

Wskazówka

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

DODAWANIE NOWEGO DOKUMENTU FAKTURY KORYGUJĄCEJ

Dodawanie faktury korygującej: [POST] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices?documentId=XXX (gdzie XXX to Id dokumentu faktury korygowanej w bazie danych) W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury korygującej z wartościami identycznymi jak na fakturze korygowanej. W kolejnym kroku należy przy wykorzystaniu metody [PUT] nanieść odpowiednie modyfikacje wynikające z procesu korygowania dokumentu.

EDYCJA FAKTURY KORYGUJĄCEJ

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie)	Nie
PaymentTypeId	Id formy płatności	Tak
PaymentDeadline	Termin płatności	Nie
BankAccountId	Id rachunku bankowego	Nie
SalesDate	Data sprzedaży	Nie
Items	Pozycje dokumentu	Nie, chyba że korekta dotyczy pozycji (korygowana jest ilość, cena netto stawka VAT lub opis) - wtedy należy podać wszystkie poniższe parametry
ProductId	Id produktu	Nie, jw.
Quantity	Ilość	Nie, jw.
ProductCurrencyPrice	Cena sprzedaży	Nie, jw.
ProductDescription	Opis produktu	Nie, jw.
VatRateId	Id stawki VAT - do pobrania ze słownika stawek VAT tutaj	Nie, jw.
Id	Id pozycji dokumentu w bazie danych	Nie, jw.
Description	Opis dokumentu	Nie
CorrectionReasonText	Przyczyna korekty	Nie
IsOSSProcedure	Oznaczenie procedury OSS (true / false)	Nie
IssueDate	Data wystawienia dokumentu	Nie
Id	Id dokumentu w bazie danych	Tak

Uwaga

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

Uwaga

Poprzez interfejs API można edytować jednie faktury zapisane do bufora.

  W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON (zwrot towaru, faktura korygująca o Id=23323962): [code_snippet id=42] Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

ZATWIERDZANIE FAKTUR KORYGUJĄCYCH

Zatwierdzanie faktur korygujących: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices/confirm W odpowiedzi zostanie wysłany status i JSON odpowiedzi. [code_snippet id=43]

USUWANIE FAKTURY KORYGUJĄCYCH

Usuwanie faktury korygującej: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices/XXX (gdzie XXX to Id dokumentu faktury korygującej w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveinvoices/23324066 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem.

Wskazówka

Opcja usuwania faktur korygujących jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury korygującej poprzez API - kliknij tutaj.  

KOREKTY DO FAKTUR ZALICZKOWYCH

W przypadku dokumentów korygujących do faktur zaliczkowych należy skorzystać z analogicznych metod jak opisane powyżej dla faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveadvanceinvoices [POST] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveadvanceinvoices?documentId=XXX [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveadvanceinvoices [PUT] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveadvanceinvoices/confirm [DEL] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveadvanceinvoices/XXX

Wskazówka

W przypadku faktur zaliczkowych dodatkowo zwracane jest pole dotyczące zaliczki: "CurrencyAdvance". Pole jest możliwe do edycji. W odróżnieniu od korekt do faktur sprzedaży, w przypadku korekt do faktur zaliczkowych nie można edytować ilości, ceny oraz stawki VAT produktów.

KOREKTY DO FAKTUR ZAKUPU

W przypadku dokumentów korygujących do faktur zakupu należy skorzystać z poniższych metod: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/correctivepurchaseinvoices [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/correctivepurchaseinvoices/XXX (gdzie XXX to Id dokumentu)

Wskazówka

Możliwe jest tylko pobierania korekt do faktu zakupu w walucie PLN i w walucie obcej

KOREKTY DO FAKTUR VAT MARŻA

W przypadku dokumentów korygujących do faktur VAT marża należy skorzystać z poniższych metod: [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveprofitmargininvoices [GET] https://app.comarchbetterfly.pl/api2/public/v1.5/correctiveprofitmargininvoices/XXX (gdzie XXX to Id dokumentu)

Wskazówka

Możliwe jest tylko pobierania korekt do faktur VAT marża w walucie PLN i w walucie obcej

POBIERANIE PŁATNOŚCI

Pobieranie płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails Opis struktury JSON odpowiedzi:

Parametr	Opis
PaymentId	Id płatności
PaymentType	INCOME - faktura sprzedaży OUTCOME - faktura zakupu INCOME_TAX - zaliczki i deklaracje dotyczące podatku dochodowego TAX_OR_FEE - inne podatki i opłat (składki PPK) VAT - podatek VAT SOCIAL_INSURANCE – składki ZUS
DocumentNumber	Numer dokumentu
CorrectedDocumentId	Jeżeli płatność jest do korekty - Id dokumentu korygowanego
CorrectedDocumentType	Jeżeli płatność jest do korekty - typ dokumentu korygowanego, przyjmuje wartości zgodne z opisem do pola DocumentType
CorrectionReason	Jeżeli płatność jest do korekty - przyczyna korekty jeżeli uzupełniono na fakturze
CreationDate	Data utworzenia płatności
UpdateDate	Data ostatniej aktualizacji płatności
IssueDate	Data płatności/dokumentu
DueDate	Termin płatności
SenderTaxId	NIP nadawcy płatności
SenderName	Nazwa firmy nadawcy płatności
SenderAddress	Adres firmy nadawcy płatności
Street	Ulica
HouseNumber	Numer domu
ApartmentNumbe	Numer lokalu
ZipCode	Kod pocztowy
City	Miasto
Region	Województwo
RecipientTaxId	NIP odbiorcy płatności
RecipientName	Nazwa firmy odbiorcy płatności
RecipientAddress	Adres firmy odbiorcy płatności
Street	Ulica
HouseNumber	Numer domu
ApartmentNumbe	Numer lokalu
ZipCode	Kod pocztowy
City	Miasto
Region	Województwo
RecipientAccountNumber	Numer rachunku bankowego odbiorcy płatności (w formacie IBAN czyli z prefiksem kraju)
Amount	Kwota płatności/dokumentu
VatAmount	Kwota VAT z dokumentu
SplitPayment	Czy zastosowano Metodę Podzielonej Płatności: true - tak, false - nie
Payable	Czy podlega rozliczeniu: true - tak, status płatności Nie rozliczono lub Częściowo rozliczono false - nie, status płatności to Anulowany lub Całkowicie rozliczony
Currency	Waluta płatności
Balance	Kwota pozostająca do zapłaty
Title	Tytuł płatności (opis do banku)
DocumentType	Typ dokumentu źródłowego: Invoice - faktura sprzedaży zwykła lub finalna AdvanceInvoice - faktura zaliczkowa PurchaseInvoice - faktura zakupu CorrectiveInvoice - korekta do faktury sprzedaży CorrectiveAdvanceInvoice - korekta do faktury sprzedaży zaliczkowej CorrectiveFiscalReceipt - korekta do paragonu CorrectivePurchaseInvoice - korekta do faktury zakupu FiscalReceipt - paragon Receipt - rachunek VatSaleBook - faktura sprzedaży dodana bezpośrednio w Rejestrze sprzedaży VAT VatPurchaseBook - faktura zakupu dodana bezpośrednio w Rejestrze zakupów VAT Vat7Declaration - deklaracja VAT/JPK_V7 Pit36Advance - zaliczka na PIT-36 Pit36LAdvance - zaliczka na PIT-36L Pit36Declaration - deklaracja PIT-36 Pit36LDeclaration - deklaracja PIT-36L ProfitMarginInvoice - faktura sprzedaży VAT marża CorrectiveProfitMarginInvoice - korekta faktury sprzedaży VAT marża OpeningBalanceItem - bilansu otwarcia BookEntryItem - zapis księgowegy Cit8Advance - zaliczka na CIT-8 Cit8Declaration - deklaracja CIT-8 PPKContributions - składka PPK ViudoDeclaration - deklaracja VIU-DO Pit28Advance - zaliczka na PIT-28 Pit28Declaration - deklaracja PIT-28 CostBook - dokument w Ewidencji Dodatkowej Kosztów RevenueBook - dokument w Ewidencji Dodatkowej Przychodów None - płatności zaimportowane z Optimy przez IWD

Przykładowa odpowiedź JSON: [code_snippet id=44] Możliwe jest także pobranie szczegółów dla jednej płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails/XXX (gdzie XXX to Id płatności w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails/2692651 Przykładowa odpowiedź JSON: [code_snippet id=45]  

POBIERANIE STATUSU PŁATNOŚCI

Pobieranie statusu płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments W zapytaniu należy podać Id płatności, które mają zostać pobrane W odpowiedzi zostanie wysłany status płatności.

Parametr	Opis
PaymentId	Id płatności
PaymentStatus	0 - nierozliczona 1 - częściowo rozliczona 2 - całkowicie rozliczona 4 - do dokumentu anulowanego 5 - anulowana
Amount	Kwota płatności/dokumentu
Balance	Kwota pozostająca do zapłaty w walucie płatności, dla płatności anulowanej: 0
Currency	Waluta dokumentu/płatności

[code_snippet id=46]   Możliwe jest także pobranie statusu dla jednej płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments/XXX (gdzie XXX to Id płatności w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments/2692651 Przykładowa odpowiedź JSON: [code_snippet id=47]  

AKTUALIZACJA STATUSU PŁATNOŚCI

Aktualizacja statusu płatności: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.4/payments Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentIds	Identyfikator płatności, które ma zostać rozliczone. Można podać więcej niż jedną płatność oddzielając Id przecinkami. Oznacza to, że dana wpłata będzie rozliczała więcej dokumentów. Kolejność rozliczania wg kolejności przesłanych Id płatności.	Tak
Cancelled	Czy płatność anulowana: true - tak, false - nie	Tak
PaymentDate	Data płatności	Tak, jeżeli Cancelled jest false
AmountPaid	Kwota zapłacona w walucie dokumentu, znak kwoty warunkuje kierunek płatności	Tak, jeżeli Cancelled jest false
BankAccountNumber	Rachunek bankowy: - dla wpłat - numer rachunku, na który przyszedł przelew, - dla wypłat - numer rachunku, z którego wyszedł przelew	Tak, jeżeli Cancelled jest false
CurrencyCode	Symbol waluty	Nie
CurrencyRateType	Typ kursu waluty	Nie
CurrencyRateDate	Data kursu	Nie
CurrencyConverter	Mianownik kursu waluty	Nie
CurrencyRate	Licznik kursu waluty	Nie
CustomerBankAccountNumber	Rachunek bankowy: - dla wpłat - numer rachunku, na który przyszedł przelew, - dla wypłat - numer rachunku, z którego wyszedł przelew	Nie
CustomerTIN	NIP kontrahenta	Nie
Description	Opis, tytuł płatności	Nie

[code_snippet id=48] W odpowiedzi JSON, mogą pojawić się następujące komunikaty błędów: ErrorCode 0 - Płatność jest już rozliczona i nie może zostać anulowana. ErrorCode 1 - Płatność jest już całkowicie rozliczona (jeżeli status całkowicie rozliczona) ErrorCode 2 - Płatność nie podlega rozliczeniu (jeżeli inny status) ErrorCode 3 - Kierunek płatności nie zgadza się z kierunkiem zapłaty ErrorCode 4 - Waluta płatności różna od waluty zapłaty ErrorCode 5 - W Comarch Betterfly nie ma rachunku o numerze .... Utwórz rachunek. ErrorCode 6 - Nie można rozliczać niezatwierdzonych płatności ErrorCode 7 - Płatność nie została rozliczona ErrorCode 8 - Waluta przypisana do rachunku bankowego nie zgadza się z walutą aktualizowanej płatności. [code_snippet id=49] Zobacz także: API - Historia zmian

POBIERANIE FAKTUR ZAKUPU Z REJESTRU VAT ZAKUPU

Pobieranie faktur z rejestru VAT zakupu: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/vatpurchasebooks Opis struktury JSON odpowiedzi:

Parametr	Opis
PaymentStatus	Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo)
CustomerId	Id dostawcy na dokumencie
PaymentTypeId	Id 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
CustomerBankAccountNumber	Numer rachunku bankowego dostawcy
CustomerBankAccountName	Nazwa banku dostawcy
BankAccountId	Id rachunku bankowego
BankAccountNumber	Numer rachunku bankowego
PurchaseDate	Data zakupu
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
Description	Opis dokumentu
IssueDate	Data wystawienia dokumentu
ReceiptDate	Data wpływu
Number	Numer obcy dokumentu
Correction	Oznaczenie czy faktura korygująca
CorrectedDocumentNumber	Numer korygowanej faktury
InternalDocument	Oznaczenie czy dokument wewnętrzny
IncludedInJPKV7	Kwalifikacja dokumentu do deklaracji JPK_V7
VATDeclatationDate	Rok i miesiąc, w którym faktura jest zakwalifikowana do JPK_V7
IncludedInVATUE	Kwalifikacja dokumentu do deklaracji VAT-UE
VATUEDeclarationDate	Rok i miesiąc, w którym faktura jest zakwalifikowana do deklaracji VAT-UE
Id	Id dokumentu w bazie danych
JpkProceduresSymbols	Tablica kodów JPK_V7
Items	Pozycje dokumentu
VatRateId	Id stawki VAT – do pobrania ze słownika stawek VAT
ItemNetValue	Kwota netto na pozycji
ItemNetValueCurrency	Kwota netto na pozycji w walucie dokumentu
ItemVATValue	Kwota VAT na pozycji
ItemVATValueCurrency	Kwota VAT na pozycji w walucie dokumentu
ItemGrossValue	Kwota brutto na pozycji
ItemGrossValueCurrency	Kwota VAT na pozycji
FieldInJPKV7	Pole w pliku JPK_V7. Oznaczenie słownika pola JPK_V7 wg poniższego klucza: 0 - Nie uwzględniaj w pliku JPK_V7 21 - (P_40) Nabycie środków trwałych 22 - (P_42) Nabycie pozostałe 24 - (P_44) Korekta podatku naliczonego od nabycia środków trwałych 25 - (P_45) Korekta podatku naliczonego od pozostałych nabyć
FieldInVATUE	Pole na deklaracji VAT-UE. Oznaczenie słownika pola VAT-UE wg poniższego klucza: 0 - Nie uwzględniaj w deklaracji 2 - D. Nabycie towarów
ItemType	Rodzaj produktu: 0 - usługa, 1 - towar
VAT50deduction	Czy odliczenie 50% VAT, 1 - tak, 0 - nie
PercentAsExpenses	Ile procent w koszty
AccountNumber	Numer konta księgowego
Id	Id pozycji dokumentu w bazie danych

Przykładowa odpowiedź JSON: [code_snippet id=12]   Możliwe jest także pobranie danych konkretnego dokumentu faktury zakupu: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/vatpurchasebooks/XXX (gdzie XXX to Id dokumentu faktury zakupu w bazie danych) Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/vatpurchasebooks/14785511

POBIERANIE FAKTUR PROFORMA

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.1/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
BankAccountId	Id rachunku bankowego
InvoiceType	Algorytm naliczania (0 - od cen netto / 1 - od cen brutto)
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ść
ProductCurrencyPrice	Cena sprzedaży
ProductDescription	Opis produktu
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:

[     {         "$id": "1",         "PurchasingPartyId": 2541748,         "ReceivingPartyId": 2541749,         "PaymentTypeId": 2016674,         "BankAccountId": null,         "InvoiceType": 0,         "Items": [             {                 "$id": "2",                 "ProductId": 2276109,                 "Quantity": 6.0000,                 "ProductCurrencyPrice": 100.00,                 "ProductDescription": "",                 "Id": 4421127             }         ],         "Description": null,         "IssueDate": "2019-12-24T00:00:00+01:00",         "Number": "PF/19/12/1",         "Status": 0,         "Id": 2721058     },     {         "$id": "3",         "PurchasingPartyId": 2541748,         "ReceivingPartyId": null,         "PaymentTypeId": 2016674,         "BankAccountId": null,         "InvoiceType": 0,         "Items": [             {                 "$id": "4",                 "ProductId": 2276109,                 "Quantity": 6.0000,                 "ProductCurrencyPrice": 100.00,                 "ProductDescription": "",                 "Id": 4421128             }         ],         "Description": null,         "IssueDate": "2019-12-24T00:00:00+01:00",         "Number": "PF/19/12/2",         "Status": 0,         "Id": 2721059     } ]

Przykładowa odpowiedź JSON

{     "$id": "1",     "PurchasingPartyId": 2541748,     "ReceivingPartyId": null,     "PaymentTypeId": 2016674,     "BankAccountId": 2004259,     "InvoiceType": 0,     "Items": [         {             "$id": "2",             "ProductId": 2276109,             "Quantity": 1.0000,             "ProductCurrencyPrice": 100.00,             "ProductDescription": "",             "Id": 4520499         },         {             "$id": "3",             "ProductId": 2276109,             "Quantity": 1.0000,             "ProductCurrencyPrice": 100.00,             "ProductDescription": "",             "Id": 4520500         }     ],     "Description": null,     "IssueDate": "2021-01-04T00:00:00+01:00",     "Number": "PF/21/1/17",     "Status": 0,     "Id": 2812310 }

Wskazówka

W API obsługiwane są faktury w walucie PLN. Nie są obsługiwane faktury w walutach obcych.

DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA

Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/v1.1/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 naliczania (0 - od cen netto / 1 - od cen brutto)	Nie1
Items	Pozycje dokumentu	Nie2
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
IssueDate	Data wystawienia dokumentu w formacie RRRR-MM-DD	Nie3
Description	Opis dokumentu	Nie

1) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu 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. Przykładowe zapytanie JSON:

{     "PurchasingPartyId": 2541748,     "ReceivingPartyId": null,     "PaymentTypeId": 2016674,     "BankAccountId": 2004259,     "InvoiceType": 0,     "Items": [         {             "$id": "2",             "ProductId": 2276109,             "Quantity": 1.0000,             "ProductCurrencyPrice": 100.00,             "ProductDescription": ""         }     ],     "Description": "Opis", }

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury proforma. Przykładowa odpowiedź:

2814939

Wskazówka

Podczas dodawania nowej faktury proforma poprzez API, dokument będzie miał nadany numer zgodnie z domyślnym schematem numeracji, ustawionym w Comarch Betterfly.

EDYCJA FAKTURY PROFORMA

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.1/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 naliczania (0 - od cen netto / 1 - od cen brutto)	Nie1
Items	Pozycje dokumentu	Tak2
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductCurrencyPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
Id	ID pozycji dokumentu w bazie danych	Nie3
IssueDate	Data wystawienia dokumentu w formacie RRRR-MM-DD	Nie
Id	Id dokumentu w bazie danych	Tak

1) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu 2) Jeśli edytowana faktura zawiera pozycje. 3) W przypadku pominięcia numeru Id pozycji podczas operacji edycji, zostanie dodana kolejna pozycja do dokumentu ze wskazanymi parametrami.

Uwaga

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

Uwaga

Poprzez 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:

{     "PurchasingPartyId": 2541748,     "ReceivingPartyId": null,     "PaymentTypeId": 2016674,     "BankAccountId": 2004259,     "InvoiceType": 0,     "Items": [         {             "$id": "2",             "ProductId": 2276109,             "Quantity": 1.0000,             "ProductCurrencyPrice": 100.00,             "ProductDescription": "",             "Id": 4520499         }     ],     "Description": null,     "Id": 2814939 }

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

brak treści

Uwaga

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

USUWANIE FAKTURY PROFORMA

Usuwanie faktur proforma: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/proformas/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/proformas/12 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

brak treści

  Usuwanie wielu faktur proforma: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/proformas, która przyjmuje obiekt o polu IdCollection który zawiera tablice reprezentującą numeru Id dokumentów do usunięcia. Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/proformas Opis struktury JSON zapytania:

{     "IdCollection": [         19697349,         19697317     ] }

Przykładowa odpowiedź JSON:

{     "Statuses": [         {             "Id": 19697349             "Success": true         },         {             "Id": 19697317,             "Success": false,             "Error": {             "Message": "Tego dokumentu nie można zmodyfikować lub usunąć.",             "Code": "DocumentException"             }         }     ] }

Uwaga

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

  Aby dowiedzieć się jak pobrać wydruk faktury proforma poprzez API – kliknij tutaj.

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices 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)
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 naliczania (0 - od cen netto / 1 - od cen brutto)
Items	Pozycje dokumentu
$id	Numer porządkowy w ramach odpowiedzi JSON
ProductId	Id produktu
Quantity	Ilość
ProductCurrencyPrice	Cena sprzedaży
ProductDescription	Opis 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:

[     {         "$id": "1",         "PaymentStatus": 0,         "PurchasingPartyId": 2558640,         "ReceivingPartyId": 2558641,         "PaymentTypeId": 2015207,         "BankAccountId": null,         "SalesDate": "2020-06-24T00:00:00+01:00",         "InvoiceType": 1,         "Items": [             {                 "$id": "2",                 "ProductId": 2290304,                 "Quantity": 1.0000,                 "ProductCurrencyPrice": 169.99,                 "ProductDescription": "",                 "Id": 4463601             }         ],         "Description": "Opis faktury",         "IssueDate": "2020-06-24T00:00:00+01:00",         "Number": "FS/20/6/1",         "Status": 1,         "Id": 2760795     },    {         "$id": "2",         "PaymentStatus": 0,         "PurchasingPartyId": 2558645,         "ReceivingPartyId": null,         "PaymentTypeId": 2015208,         "BankAccountId": null,         "SalesDate": "2020-07-28T00:00:00+01:00",         "InvoiceType": 1,         "Items": [             {                 "$id": "4",                 "ProductId": 2290519,                 "Quantity": 1.0000,                 "ProductCurrencyPrice": 599.99,                 "ProductDescription": "",                 "Id": 4464201             }         ],         "Description": null,         "IssueDate": "2020-07-28T00:00:00+01:00",         "Number": "FS/20/7/25",         "Status": 1,         "Id": 2761381     } ]

Przykładowa odpowiedź JSON:

{     "$id": "1",     "PaymentStatus": 1,     "PurchasingPartyId": 2541836,     "ReceivingPartyId": 2541748,     "PaymentTypeId": 2016674,     "BankAccountId": 2004259,     "SalesDate": "2021-01-07T00:00:00+01:00",     "InvoiceType": 1,     "Items": [         {             "$id": "2",             "ProductId": 2276109,             "Quantity": 1.0000,             "ProductCurrencyPrice": 100.00,             "ProductDescription": "4526160",             "Id": 4526160         }     ],     "Description": "2814943",     "IssueDate": "2021-01-07T12:50:43+01:00",     "Number": "FS/2021/1/6",     "Status": 0,     "Id": 2814943 }

Wskazówka

W API obsługiwane są faktury sprzedaży w buforze. Dodatkowo można pobrać dane i wydruki dla faktur zatwierdzonych na stałe. Nie są obsługiwane faktury zaliczkowe, faktury finalne, dokumenty anulowane oraz korekty.

Wskazówka

W API obsługiwane są faktury w walucie PLN. Nie są obsługiwane faktury w walutach obcych.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 - niezapłacona, 1 - zapłacona całkowicie)1	Nie1
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 w formacie RRRR-MM-DD	Nie2
InvoiceType	Algorytm naliczania (0 - od cen netto / 1 - od cen brutto)	Nie3
Items	Pozycje dokumentu	Nie4
ProductId	Id produktu	Tak
Quantity	Ilość	Tak
ProductNetPrice	Cena netto sprzedaży	Tak
ProductDescription	Opis produktu	Nie
IssueDate	Data wystawienia dokumentu w formacie RRRR-MM-DD	Nie5

1) 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). 2) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca. 3) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu 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. Przykładowe zapytanie JSON:

{     "PaymentStatus": 1,     "PurchasingPartyId": 2567977,     "ReceivingPartyId": 2541748,     "PaymentTypeId": 2015209,     "BankAccountId": 2004805,     "InvoiceType": 1,     "Items": [         {             "ProductId": 2301251,             "Quantity": 10.0000,             "ProductCurrencyPrice": 112.00,             "ProductDescription": "Opis dokumentu",             "Id": 4494377         }     ] }

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży. Przykładowa odpowiedź:

2814937

Wskazówka

Podczas dodawania nowej faktury sprzedaży poprzez API, dokument będzie miał nadany numer zgodnie z domyślnym schematem numeracji, ustawionym w Comarch Betterfly.

Wskazówka

Faktury sprzedaży dodawane do Comarch Betterfly poprzez API zawsze będą miały status "Zapisane" (w buforze). Wszelkie dalsze operacje - np. zatwierdzenia i księgowania dokumentu - należy wykonywać po zalogowaniu do aplikacji.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
PaymentStatus	Status płatności (0 - niezapłacona, 1 - zapłacona całkowicie)	Tak
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 w formacie RRRR-MM-DD	Nie
InvoiceType	Algorytm naliczania (0 - od cen netto / 1 - od cen brutto)	Nie2
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	Nie3
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 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.

Uwaga

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

Uwaga

Poprzez interfejs API można edytować jednie faktury zapisane do bufora.

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi. Przykładowe zapytanie JSON:

{     "PaymentStatus": 1,     "PurchasingPartyId": 2567977,     "ReceivingPartyId": 2541748,     "PaymentTypeId": 2015209,     "BankAccountId": 2004805,     "InvoiceType": 1,     "Items": [         {             "ProductId": 2301251,             "Quantity": 10.0000,             "ProductCurrencyPrice": 112.00,             "ProductDescription": "Opis dokumentu",             "Id": 4494377         }     ],     "Description": null,     "IssueDate": "2020-10-26T00:00:00+01:00",     "Id": 2814943 }

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

brak treści

Uwaga

Opcja edycji faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych) Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.1/invoices/2814943 Przykładowa odpowiedź JSON – status 204 No Content - operacja zakończona powodzeniem:

brak treści

Uwaga

Opcja usuwania faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

  Aby dowiedzieć się jak pobrać wydruk faktury sprzedaży poprzez API - kliknij tutaj.