Dokumentacja

Klienci

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

Definicja

Obiekt Client zawiera następujące klucze:

ParametrTyp danychWymaganyOpis
idintegerTylko do odczytuID Klienta
company_namestringTak, jeśli została uzupełniona wartość dla client_business_activity_kind i oznacza ona JDG lub inny rodzaj działalnościNazwa firmy
streetstringNieUlica
street_numberstringNieNumer budynku
flat_numberstringNieNumer mieszkania
citystringNieMiasto
countrystringTakKraj (pole alpha_2 z listy obsługiwanych krajów)
postal_codestringNieKod pocztowy w formacie NN-NNN
nipstringNieNIP
clean_nipstringTylko do wyszukiwaniaPozwala na wyszukiwanie NIPu w postaci ciągu cyfr.
Np 111-111-11-11 można wyszukiwać jako 1111111111
phone_numberstringNieNumer telefonu
same_forward_addressbooleanNieAdres korespondencyjny taki jak adres firmowy true lub false, domyślnie true
web_sitestringNieAdres strony internetowej
emailstringNieAdres email
notestringNieUwagi
receiverstringNieOdbierający dokument
mailing_company_namestringNieNazwa firmy do korespondencji
mailing_streetstringNieUlica do korespondencji
mailing_citystringNieMiasto do korespondencji
mailing_postal_codestringNieKod pocztowy do korespondencji w formacie NN-NNN
days_to_paymentintegerNieDomyślny termin płatności w dniach dla tego klienta
invoice_notestringNieDomyślne uwagi do faktur klienta
payment_methodstringNieMetoda 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
first_namestringTak, jeśli została uzupełniona wartość dla client_business_activity_kind i oznacza ona osobę prywatną lub JDGImię klienta
last_namestringTak, jeśli została uzupełniona wartość dla client_business_activity_kind i oznacza ona osobę prywatną lub JDGNazwisko klienta
business_activity_kindstringNieRodzaj działalności:
  • private_person – osoba prywatna,
  • self_employed – jednoosobowa działalność gospodarcza,
  • other_business – inny rodzaj działalności

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 odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
401Brak 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 odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
401Brak 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 odpowiedziOpis
201Zasób został poprawnie utworzony
422Zwracany 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 odpowiedziOpis
200Zapytanie zostało wykonane poprawnie
422Zwracany 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 odpowiedziOpis
204Zwracany po poprawnym usunięciu zasobu.
401Brak autoryzacji lub uprawnień do danego zasobu