API – Formy płatności - Baza Wiedzy programu Comarch Betterfly

POBIERANIE FORM PŁATNOŚCI

[GET] https://app.comarchbetterfly.pl/api2/public/paymenttypes

Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
Name	Nazwa formy płatności
Primary	Czy forma płatności jest jako „domyślna” – true (TAK) / false (NIE)
Type	Typ płatności: 0 – płatność gotówką 1 – płatność na konto 2 – płatność kartą
Id	Id formy płatności

Przykładowa odpowiedź JSON:

[code_snippet id=25]

Możliwe jest także pobranie danych na temat określonej formy płatności.

[GET] https://app.comarchbetterfly.pl/api2/public/paymenttypes/XXX (gdzie XXX to Id formy płatności w bazie danych)

Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/paymenttypes/5

Przykładowa odpowiedź JSON:

[code_snippet id=26]

DODAWANIE NOWEJ FORMY PŁATNOŚCI

[POST] https://app.comarchbetterfly.pl/api2/public/paymenttypes

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
Name	Nazwa formy płatności	TAK
Primary	Czy forma płatności jest jako „domyślna” – true (TAK) / false (NIE)	NIE
Deadline	liczby całkowite z zakresu <0,366>	TAK
Type	Typ płatności: 0 – płatność gotówką 1 – płatność na konto 2 – płatność kartą	TAK

Wskazówka

Może istnieć tylko jedna domyślna forma płatności. Po zaznaczeniu parametru Primary na „true” dana płatność automatycznie staje się podstawową.

Przykładowe zapytanie JSON:

[code_snippet id=27]

W odpowiedzi zostanie wysłane ID dodanej formy płatności.

EDYCJA FORMY PŁATNOŚCI

[PUT] https://app.comarchbetterfly.pl/api2/public/paymenttypes

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
Name	Nazwa formy płatności	TAK
Primary	Czy forma płatności jest jako „domyślna” – true (TAK) / false (NIE)	NIE
Deadline	liczby całkowite z zakresu <0,366>	TAK
Type	Typ płatności: 0 – płatność gotówką 1 – płatność na konto 2 – płatność kartą	TAK
ID	Id formy płatności w bazie danych	TAK

Wskazówka

Podczas edycji formy płatności, która jest już domyślna (Primary = true), nie można zmienić jej na „false”. Zawsze musi istnieć jedna domyślna forma płatności.

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 (zmiana typu formy płatności o Id=29017):

[code_snippet id=28]

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

USUWANIE FORMY PŁATNOŚCI

[DEL] https://app.comarchbetterfly.pl/api2/public/paymenttypes/XXX (gdzie XXX to Id formy płatności w bazie danych)

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

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

Wskazówka

Nie można usuwać domyślnej formy płatności.