API – Rachunki bankowe - Baza Wiedzy programu Comarch Betterfly

POBIERANIE RACHUNKÓW BANKOWYCH

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

Opis struktury JSON odpowiedzi:

Parametr	Opis
$id	Numer porządkowy w ramach odpowiedzi JSON
AccountNumber	Numer rachunku
BankName	Nazwa banku
Symbol	Symbol banku
ReportingPeriod	Okres raportów 1 – Dzienny 2 – Tygodniowy 3 – Miesięczny 4 – Bezterminowy
Primary	Czy rachunek jest jako „domyślny” – true (TAK) / false (NIE)
Id	Id rachunku bankowego

Przykładowa odpowiedź JSON:

[code_snippet id=29]

Możliwe jest także pobranie danych dla określonego rachunku.

[GET] https://app.comarchbetterfly.pl/api2/public/bankaccounts/XXX (gdzie XXX to Id rachunku bankowego w bazie danych)

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

Przykładowa odpowiedź JSON:

[code_snippet id=30]

Wskazówka

Metoda pobierania rachunków bankowych pomija pozycje, które oznaczono jako „Rachunek VAT”, ponieważ nie jest możliwe wskazanie ich na fakturze sprzedaży.

DODAWANIE NOWEGO RACHUNKU BANKOWEGO

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

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
AccountNumber	Numer rachunku	TAK
BankName	Nazwa banku	NIE
Symbol	Symbol banku	TAK
ReportingPeriod	Okres raportów 1 – Dzienny 2 – Tygodniowy 3 – Miesięczny 4 – Bezterminowy	TAK
Primary	Czy rachunek jest jako „domyślny” – true (TAK) / false (NIE)	NIE

Wskazówka

Rachunki bankowe dodawane są w walucie PLN.

Wskazówka

Zmiana domyślnego rachunku bankowego (parametr: Primary) w aplikacji na stronie www jest widoczna dopiero po ponownym zalogowaniu bądź odświeżeniu strony konfiguracji Comarch Betterfly (ctr+F5).

Przykładowe zapytanie JSON:

[code_snippet id=31]

W odpowiedzi zostanie wysłane ID dodanego rachunku bankowego.

EDYCJA RACHUNKU BANKOWEGO

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

Opis struktury JSON zapytania:

Parametr	Opis	Czy parametr obowiązkowy?
AccountNumber	Numer rachunku	TAK
BankName	Nazwa banku	NIE
Symbol	Symbol banku	TAK¹
ReportingPeriod	Okres raportów 1 – Dzienny 2 – Tygodniowy 3 – Miesięczny 4 – Bezterminowy	TAK
Primary	Czy rachunek jest jako „domyślny” – true (TAK) / false (NIE)	NIE
ID	Id rachunku bankowego w bazie danych	TAK

Uwaga

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

1) Symbol banku nadawany jest podczas dodawania rachunku i nie można go edytować.

Przykładowe zapytanie JSON (zmiana okresu raportu dla rachunku bankowego o Id=8844):

[code_snippet id=32]

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

USUWANIE RACHUNKU BANKOWEGO

Usuwanie rachunku bankowego: [DEL] https://app.comarchbetterfly.pl/api2/public/bankaccounts/XXX (gdzie XXX to Id rachunku bankowego w bazie danych)

Uwaga

Nie można usunąć domyślnego rachunku bankowego.

Uwaga

Usunięcie rachunku bankowego nie jest możliwe gdy jest powiązany z dokumentem, zapłatą, raportem lub został podany w konfiguracji jako rachunek płatności dla deklaracji.

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

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