Parametry list | API inFakt

Format odpowiedzi

Operacje zwracające listy zwracają metadane i elementy listy:

{
  "metainfo": {
    "count": 10,
    "total_count": 42,
    "next": "https://api.infakt.pl/v3/clients.json?limit=10&offset=10",
    "previous": "https://api.infakt.pl/v3/clients.json?limit=10&offset=0"
  },
  "entities": []
}

Pole	Znaczenie
`count`	liczba elementów na bieżącej stronie
`total_count`	liczba wszystkich elementów pasujących do zapytania
`next`, `previous`	adres żądania ze wszystkimi parametrami oraz nowymi wartościami `offset` i `limit`

Stronicowanie

Parametr	Domyślnie	Uwagi
`offset`	`0`	Jeśli zostanie przesłany, parametry `page` i `per_page` są ignorowane.
`limit`	`10`	Bez parametru `offset` jest ignorowany. Większość list ogranicza wartości powyżej `100` do `100`.
`page`	`1`	Brany pod uwagę tylko bez parametru `offset`.
`per_page`	`10`	Brany pod uwagę tylko bez parametru `offset`.
`pagination_without_total`	`false`	Wartość `true` wyłącza liczenie wszystkich elementów: `total_count` ma wartość `null`, a odpowiedź jest szybsza.

Filtrowanie

Do filtrowania służy parametr q[<pole>_<predykat>], np. q[company_name_cont]=sp. Pola dostępne do filtrowania podaje referencja API przy każdej liście.

Predykat	Znaczenie
`_eq`	równe
`_not_eq`	różne
`_cont`	zawiera
`_start`	zaczyna się od
`_end`	kończy się na
`_lt`, `_lteq`	mniejsze, mniejsze lub równe
`_gt`, `_gteq`	większe, większe lub równe
`_null`	brak wartości
`_in`	jedna z podanych wartości

Przykłady: q[company_name_cont]=sp (klienci, których nazwa zawiera „sp”), q[invoice_date_gteq]=2026-10-01 (faktury wystawione od 1 października 2026 r.).

Sortowanie

Parametr order=<pole> sortuje rosnąco, a order=<pole> desc malejąco, np. order=payment_date desc. Spację w adresie URL koduje się jako %20 lub +. Sortować można po polach elementów listy.

Wybór pól

Parametr fields ogranicza odpowiedź do wskazanych pól, oddzielonych przecinkami: fields=id,company_name. Mniejsza odpowiedź jest przesyłana szybciej.

Przykład

curl "https://api.sandbox-infakt.pl/v3/clients.json?q%5Bcompany_name_cont%5D=sp&order=company_name&fields=id,company_name&offset=0&limit=50" \
  -H "X-inFakt-ApiKey: $INFAKT_API_KEY"