Pobierz listę klientów

Zakres: api:invoices:read. Sortowanie po company_name, chyba że podano order.

fields, order i filtry nie działają z street_number, country_full_name, same_forward_address, is_vindicable i vindicable_invoices_count; w fields powodują 500.

GET

https://api.sandbox-infakt.pl/v3/clients.json

Autoryzacja

ApiKey
opcjonalne
API key in header

Token
opcjonalne
API key in header

Query parameters

page
opcjonalne
integer
Numer strony liczony od 1; ignorowany, gdy wysłany jest offset.

format: int32 · default: 1
per_page
opcjonalne
integer
Liczba wyników na stronę przy page. Serwer jej nie ogranicza.

format: int32 · default: 10
offset
opcjonalne
integer
Indeks pierwszego wyniku (liczba pomijanych encji).

format: int32
limit
opcjonalne
integer
Liczba wyników na stronę przy offset; domyślnie 10, ignorowana bez offset. Większość list bez błędu obniża wartości powyżej 100 do 100.

format: int32
pagination_without_total
opcjonalne
boolean
Pomiń liczenie; metainfo.total_count przyjmuje wartość null.
fields
opcjonalne
string
Zawężenie pól: nazwy pól API rozdzielone przecinkami, np. id,company_name; id jest zwykle dodawane. Odpowiedź zawiera wtedy tylko te pola, więc nie odpowiada pełnemu schematowi. Pola wyliczane, a nie zapisywane, mogą kończyć się błędem 500; operacja je wymienia.
order
opcjonalne
string
Sortowanie: <pole>, <pole> asc albo <pole> desc z nazwą pola API, np. name desc. Pole, po którym nie da się sortować, jest ignorowane bez błędu.
q[company_name_cont]
opcjonalne
string
Nazwa firmy zawiera.
q[nip_eq]
opcjonalne
string
NIP równy, dokładnie tak jak zapisany (z myślnikami lub bez).
q[clean_nip_eq]
opcjonalne
string
Cyfry NIP równe, z pominięciem myślników, spacji i prefiksu kraju po obu stronach, np. 5260250274.
q[email_cont]
opcjonalne
string
E-mail zawiera.
q[business_activity_kind_eq]
opcjonalne
private_person
or
self_employed
or
other_business
Forma prawna klienta.

Odpowiedzi

200

Sukces

JSON

metainfo
object
wymagane
- count
  integer
  wymagane
  Liczba encji na tej stronie.
  
  format: int32
- total_count
  wymagane
  Liczba pasujących encji; null, gdy pagination_without_total=true.
  
  One of the following:
  integer
  null
- next
  string
  wymagane
  Bezwzględny URL następnej strony w postaci offset/limit.
- previous
  string
  wymagane
  Bezwzględny URL poprzedniej strony w postaci offset/limit.
}
entities
array of
object
wymagane
- id
  integer
  wymagane
  format: int64
- uuid
  string
  wymagane
  format: uuid
- company_name
  wymagane
  null, gdy business_activity_kind to private_person.
  
  One of the following:
  string
  null
- street
  wymagane
  One of the following:
  string
  null
- street_number
  wymagane
  One of the following:
  string
  null
- flat_number
  wymagane
  One of the following:
  string
  null
- city
  string
  wymagane
- country
  string
  wymagane
  Dwuliterowy kod kraju jak alpha_2 w GET /countries.json: ISO 3166-1 alpha-2, z wyjątkiem EL dla Grecji (GR nie jest rozpoznawany) i XI dla Irlandii Północnej.
  
  pattern: ^[A-Z]{2}$
- country_full_name
  string
  wymagane
  Nazwa kraju po polsku.
- postal_code
  wymagane
  One of the following:
  string
  null
- nip
  wymagane
  One of the following:
  Nip
  null
- phone_number
  wymagane
  One of the following:
  string
  null
- web_site
  string
  wymagane
- email
  wymagane
  Do 5 adresów oddzielonych przecinkami.
  
  One of the following:
  string
  null
- note
  string
  wymagane
- receiver
  string
  wymagane
  Osoba upoważniona do odbioru dokumentów.
- mailing_company_name
  wymagane
  Pola adresu korespondencyjnego są "", gdy same_forward_address to true.
  
  One of the following:
  string
  null
- mailing_street
  wymagane
  One of the following:
  string
  null
- mailing_city
  wymagane
  One of the following:
  string
  null
- mailing_postal_code
  wymagane
  One of the following:
  string
  null
- days_to_payment
  wymagane
  Domyślny termin płatności w dniach dla tego klienta; "", gdy nie ustawiono.
  
  One of the following:
  integer
  string
- payment_method
  wymagane
  Domyślna metoda płatności; "", gdy nie ustawiono.
  
  One of the following:
  PaymentMethod
  string
- invoice_note
  string
  wymagane
  Domyślne uwagi do faktur klienta.
- same_forward_address
  boolean
  wymagane
  Adres korespondencyjny taki sam jak adres firmowy.
- first_name
  wymagane
  One of the following:
  string
  null
- last_name
  wymagane
  One of the following:
  string
  null
- business_activity_kind
  wymagane
  One of the following:
  BusinessActivityKind
  null
- is_vindicable
  boolean
  wymagane
  Klient ma przeterminowane faktury, które można skierować do windykacji.
- vindicable_invoices_count
  integer
  wymagane
  format: int32
}

400

Nieprawidłowe parametry wyszukiwania (q[...]); na niektórych endpointach także nieprawidłowe parametry stronicowania.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

406

Ścieżka nie kończy się na .json.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

{ "metainfo": { "count": 1, "total_count": 1, "next": "https://api.infakt.pl/v3/clients.json?q%5Bcompany_name_cont%5D=Testowa&offset=10&limit=10", "previous": "https://api.infakt.pl/v3/clients.json?q%5Bcompany_name_cont%5D=Testowa&offset=0&limit=10" }, "entities": [ { "id": 1003, "uuid": "aae6796c-30a9-4bc6-ae55-6b2f08a8a0f6", "company_name": "Pierwsza Testowa Spółka sp z o.o.", "street": "Lwowska", "street_number": "10", "flat_number": "17", "city": "Kraków", "country": "PL", "country_full_name": "Polska", "postal_code": "31-202", "nip": "222-22-22-222", "phone_number": "500100200", "web_site": "", "email": "biuro@example.com", "note": "", "receiver": "", "mailing_company_name": "", "mailing_street": "", "mailing_city": "", "mailing_postal_code": "", "days_to_payment": "", "payment_method": "", "invoice_note": "", "same_forward_address": true, "first_name": null, "last_name": null, "business_activity_kind": "other_business", "is_vindicable": false, "vindicable_invoices_count": 0 } ] }