Dokumentacja

Klienci

Zarządzanie Klientami należącymi do użytkownika

Definicja

Obiekt Client zawiera następujące klucze:

Parametr Typ danych Wymagany Opis
id integer Tylko do odczytu ID Klienta
company_name string Tak Nazwa firmy
street string Nie Ulica
street_number string Nie Numer budynku
flat_number string Nie Numer mieszkania
city string Nie Miasto
country string Tak Kraj (pole alpha_2 z listy obsługiwanych krajów)
postal_code string Nie Kod pocztowy w formacie NN-NNN
nip string Nie NIP
clean_nip string Tylko do wyszukiwania Pozwala na wyszukiwanie NIPu w postaci ciągu cyfr.
Np 111-111-11-11 można wyszukiwać jako 1111111111
phone_number string Nie Numer telefonu
same_forward_address boolean Nie Adres korespondencyjny taki jak adres firmowy true lub false, domyślnie true
web_site string Nie Adres strony internetowej
email string Nie Adres email
note string Nie Uwagi
receiver string Nie Odbierający dokument
mailing_company_name string Nie Nazwa firmy do korespondencji
mailing_street string Nie Ulica do korespondencji
mailing_city string Nie Miasto do korespondencji
mailing_postal_code string Nie Kod pocztowy do korespondencji w formacie NN-NNN
days_to_payment integer Nie Domyślny termin płatności w dniach dla tego klienta
invoice_note string Nie Domyślne uwagi do faktur klienta
payment_method string Nie Metoda płatności:
  • transfer – Przelew
  • cash – Gotówka
  • card – Karta płatnicza
  • barter – Barter
  • check – Czek
  • bill_of_sale – Weksel
  • delivery – Za pobraniem
  • compensation – Kompensata
  • accredited – Akredytywa
  • paypal – PayPal
  • instalment_sale – Sprzedaż ratalna
  • payu – PayU
  • tpay – Tpay
  • przelewy24 – Przelewy24
  • dotpay – Dotpay
  • other – Inny

Listowanie klientów

GET /v3/clients.json

Akcja listowania zwraca odpowiedź zawierającą tablicę obiektów pod kluczem entities oraz informacje pomocnicze dotyczące stronicowania. Domyślne sortowanie dla zwracanej tablicy odbywa się rosnące przy użyciu pola company_name.

Dodatkowo, na zbiorze danych można wykonywać nastepujące operacje:

Przykład akcji listowania:

Przykład curl

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/clients.json

Przykładowa odpowiedź

{
  "metainfo": {
      "count": 10,
      "total_count": 10,
      "next": "https://api.infakt.pl/api/v3/clients.json?offset=10",
      "previous": "https://api.infakt.pl/api/v3/clients.json?offset=0"
  },
  "entities": [{
    "id": 17,
    "company_name": "Infakt Sp. z o.o.",
 ...
  }, {
    "id": 16,
    "company_name": "Infakt Biuro Rachunkowe Sp. z o.o.",
    ...
  }]
}

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
401 Brak autoryzacji lub uprawnień do danego zasobu

Podgląd klienta

GET /v3/clients/{id}.json

Dodatkowo, na zbiorze danych można wykonywać nastepujące operacje:

Przykład curl

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  https://api.infakt.pl/v3/clients/13.json

Przykładowa odpowiedź

{
 "id": 13,
  "company_name": "Infakt Biuro Rachunkowe Sp. z o.o.",
  "street": "Szlak",
  "street_number": "49",
  "flat_number": "",
  "city": "Kraków",
  "country": "PL",
  "postal_code": "31-148",
  "nip": "",
  ...
}

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
401 Brak autoryzacji lub uprawnień do danego zasobu

Tworzenie klienta

POST /v3/clients.json

Tworzenie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X POST
-d '{"client":{
  "company_name": "Infakt Biuro Rachunkowe Sp. z o.o.",
  "street": "Szlak",
  "street_number": "49",
  "flat_number": "",
  "city": "Kraków",
  "country": "PL",
  "postal_code": "31-148",
  "nip": "",
  ...
}}' \
https://api.infakt.pl/v3/clients.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
201 Zasób został poprawnie utworzony
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Aktualizacja klienta

PUT /v3/clients/{id}.json

Aktualizacja

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -H "Content-Type: application/json" \
  -X PUT \
-d '{"client":{
  "company_name": "Infakt Sp. z o.o.",
  "nip": "9452121681",
  ...
}}' \
  https://api.infakt.pl/v3/clients/1.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
200 Zapytanie zostało wykonane poprawnie
422 Zwracany wraz z informacją o błędach w przypadku problemów z zasobem.

Usuwanie klienta

DELETE /v3/clients/{id}.json

Usuwanie

curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
  -X DELETE \
  https://api.infakt.pl/v3/clients/1.json

Możliwe kody odpowiedzi:

Kod odpowiedzi Opis
204 Zwracany po poprawnym usunięciu zasobu.
401 Brak autoryzacji lub uprawnień do danego zasobu