API – Kontrahenci

POBIERANIE KONTRAHENTÓW

Pobieranie kontrahentów: [GET] https://app.erpxt.pl/api2/public/v1.2/customers

Opis struktury JSON odpowiedzi:

Parametr Opis
$id Numer porządkowy w ramach odpowiedzi JSON
Name Nazwa kontrahenta
CountryCode Oznaczenie kodu kraju kontrahenta (prefix NIP)
Możliwa jest pusta wartość, która powinna być stosowana dla kontrahenta krajowego niezarejestrowanego w VAT-UE
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)
RepresentativeFirstName
 Imię przedstawiciela
RepresentativeLastName
 Nazwisko przedstawiciela
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
CustomerStatus Status kontrahenta:
0 – krajowy
1 – wewnątrzunijny
2 – pozaunijny
3 – wewnątrzunijny trójstronny
10 – procedura OSS
Id ID kontrahenta w bazie danych

Przykładowa odpowiedź JSON:

[
    {
        "Name": "COMARCH SPÓŁKA AKCYJNA",
        "CountryCode": "",
        "CustomerTaxNumber": "6770065406",
        "CustomerCode": "K/000369",
        "Mail": "",
        "PhoneNumber": "",
        "CustomerType": 1,
        "Address": {
            "Street": "Aleja Jana Pawła II",
            "BuildingNumber": "39 A",
            "FlatNumber": "",
            "PostalCode": "31-864",
            "City": "Kraków",
            "Id": 529657
        },
        "CustomerStatus": 0,
        "RepresentativeFirstName": "Jan",
        "RepresentativeLastName": "Kowalski",
        "Id": 529611
    },
    {
        "Name": "COMARCH HEALTHCARE SPÓŁKA AKCYJNA",
        "CountryCode": "",
        "CustomerTaxNumber": "6751382502",
        "CustomerCode": "K/000371",
        "Mail": "",
        "PhoneNumber": "",
        "CustomerType": 1,
        "Address": {
            "Street": "Aleja Jana Pawła II",
            "BuildingNumber": "39A",
            "FlatNumber": "",
            "PostalCode": "31-864",
            "City": "Kraków",
            "Id": 529660
        },
        "CustomerStatus": 0,
        "RepresentativeFirstName": "Jan",
        "RepresentativeLastName": "Kowalski",
        "Id": 529614
    }
]

Możliwe jest także pobranie karty określonego kontrahenta:

[GET] https://app.erpxt.pl/api2/public/v1.2/customers/{id}

oraz pobieranie danych o określonym NIP:

[GET] https://app.erpxt.pl/api2/public/v1.2/customers/?nip={nip}

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.2/customers/?nip=6770065406

 

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

  • wg nazwy: [GET] https://app.erpxt.pl/api2/public/v1.2/customers/?$filter=Name eq {nazwa}
  • wg adresu e-mail: [GET] https://app.erpxt.pl/api2/public/v1.2/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.erpxt.pl/api2/public/v1.2/customers/?$filter=Name eq 'Comarch'
https://app.erpxt.pl/api2/public/v1.2/customers/?$filter=Mail eq 'demo@comarch.pl'

DODAWANIE NOWEGO KONTRAHENTA

Dodawanie kontrahenta: [POST] https://app.erpxt.pl/api2/public/v1.2/customers

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
Name Nazwa kontrahenta Tak
CountryCode Oznaczenie kraju kontrahenta W wybranych przypadkach, zależnie od rodzaju kontrahenta4
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
RepresentativeFirstName Imię przedstawiciela Nie
RepresentativeLastName Nazwisko przedstawiciela Nie
Address Sekcja z adresem kontrahenta
       Street Ulica Nie
       BuildingNumber Numer domu Nie
       FlatNumber Lokal Nie
       PostalCode Kod pocztowy Nie
       City Poczta Nie
CustomerStatus Status kontrahenta:
0 – krajowy
1 – wewnątrzunijny
2 – pozaunijny
3 – wewnątrzunijny trójstronny
10 – procedura OSS		 Nie3

1) W przypadku braku kodu zostanie on nadany poprzez serwer.

2) W przypadku braku rodzaju zostanie zastosowane ustawienie domyślne (podmiot gospodarczy).

3) W przypadku braku statusu zostanie on nadany wg kodu kraju, a w przypadku braku kodu kraju zostanie zastosowane ustawienie domyślne (kontrahent krajowy)

4) Kod kraju jest obowiązkowy dla kontrahentów wewnątrzunijnych i procedury OSS.

Przykładowe zapytanie JSON:

{
    "Name": "COMARCH CLOUD SPÓŁKA AKCYJNA",
    "CustomerTaxNumber": "6751402274",
    "Mail": "erpxt@comarch.pl"
}

W odpowiedzi zostanie wysłane ID dodanego kontrahenta.

EDYCJA KONTRAHENTA

Edycja kontrahenta: [PUT] https://app.erpxt.pl/api2/public/v1.2/customers

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
Name Nazwa kontrahenta Tak
CountryCode Oznaczenie kraju kontrahenta W wybranych przypadkach, zależnie od rodzaju kontrahenta.
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
RepresentativeFirstName Imię przedstawiciela Nie
RepresentativeLastName Nazwisko przedstawiciela 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
CustomerStatus Status kontrahenta:
0 – krajowy
1 – wewnątrzunijny
2 – pozaunijny
3 – wewnątrzunijny trójstronny
10 – procedura OSS		 Nie
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):

{
    "Name": "COMARCH CLOUD SPÓŁKA AKCYJNA",
    "CustomerTaxNumber": "6751402274",
    "Mail": "erpxt2@comarch.pl",
    "Id": 2
}

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

USUWANIE KARTY KONTRAHENTA

Usuwanie kontrahenta: [DEL] https://app.erpxt.pl/api2/public/v1.2/customers/XXX (gdzie XXX to Id kontrahenta w bazie danych)

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/customers/3

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

Czy ten artykuł był pomocny?

Wyślij opnie