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