inFakt API

https://docs.infakt.pl
Admin
inFakt API provides integrations and ready-made solutions for developers to connect with inFakt...
Tokens:8,762
Snippets:42
Trust Score:9.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### GET /api/v3/clients.json?offset=10&limit=50

Source: https://docs.infakt.pl/

Example of paginating the clients list endpoint using offset and limit parameters.

```APIDOC
## GET /api/v3/clients.json

### Description
Paginates the clients list endpoint using offset and limit parameters.

### Method
GET

### Endpoint
/api/v3/clients.json

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of items to skip before starting to collect the result set.
- **limit** (integer) - Optional - The maximum number of items to return. Maximum value is 100.

### Request Example
GET /api/v3/clients.json?offset=10&limit=50

### Response
#### Success Response (200)
Returns a paginated list of clients.

#### Response Example
{
  "metainfo": {
    "count": 4,
    "total_count": 4,
    "next": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=10",
    "previous": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=0"
  },
  "entities": [
    {
      "id": 4,
      "bank_name": "Bank4"
    },
    {
      "id": 3,
      "bank_name": "Bank3"
    },
    {
      "id": 2,
      "bank_name": "Bank2"
    },
    {
      "id": 1,
      "bank_name": "Bank1"
    }
  ]
}
```

--------------------------------

### GET /api/v3/products.json?offset=0&limit=100

Source: https://docs.infakt.pl/

Example of paginating the products list endpoint using offset and limit parameters.

```APIDOC
## GET /api/v3/products.json

### Description
Paginates the products list endpoint using offset and limit parameters.

### Method
GET

### Endpoint
/api/v3/products.json

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of items to skip before starting to collect the result set.
- **limit** (integer) - Optional - The maximum number of items to return. Maximum value is 100.

### Request Example
GET /api/v3/products.json?offset=0&limit=100

### Response
#### Success Response (200)
Returns a paginated list of products.

#### Response Example
{
  "metainfo": {
    "count": 4,
    "total_count": 4,
    "next": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=10",
    "previous": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=0"
  },
  "entities": [
    {
      "id": 4,
      "bank_name": "Bank4"
    },
    {
      "id": 3,
      "bank_name": "Bank3"
    },
    {
      "id": 2,
      "bank_name": "Bank2"
    },
    {
      "id": 1,
      "bank_name": "Bank1"
    }
  ]
}
```

--------------------------------

### Example response for bank accounts with fields=bank_name

Source: https://docs.infakt.pl/

Example JSON response for the bank accounts request with fields=bank_name. The response includes metainfo with pagination links and an entities array containing only the requested fields.

```json
{
  "metainfo": {
      "count": 4,
      "total_count": 4,
      "next": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=10",
      "previous": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=0"
  },
  "entities": [
    {
      "id": 4,
      "bank_name": "Bank4"
    },
    {
      "id": 3,
      "bank_name": "Bank3"
    },
    {
      "id": 2,
      "bank_name": "Bank2"
    },
    {
      "id": 1,
      "bank_name": "Bank1"
    }
  ]
}
```

--------------------------------

### GET /api/v3/products.json - sortowanie rosnące

Source: https://docs.infakt.pl/

Pobiera listę produktów z sortowaniem rosnącym po nazwie, z limitem i offsetem.

```APIDOC
## GET /api/v3/products.json

### Description
Pobiera listę produktów z sortowaniem rosnącym po nazwie, z limitem i offsetem.

### Method
GET

### Endpoint
/api/v3/products.json

### Parameters
#### Query Parameters
- **fields** (string) - Required - Lista pól do zwrócenia, np. `name`.
- **offset** (integer) - Required - Przesunięcie wyniku.
- **limit** (integer) - Required - Liczba wyników na stronę.
- **order** (string) - Required - Format: `nazwa_parametru typ_sortowania`, np. `name asc`.

### Request Example
```
GET /api/v3/products.json?fields=name&offset=10&limit=5&order=name asc
```

### Response
#### Success Response (200)
- **metainfo** (object) - Zawiera informacje o liczbie wyników i linki do następnej/poprzedniej strony.
- **entities** (array) - Lista obiektów produktów.

#### Response Example
```json
{
  "metainfo": {
    "count": 3,
    "total_count": 467,
    "next": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=15&limit=5&order=name asc",
    "previous": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=5&limit=5&order=name asc"
  },
  "entities": [
    {
      "id": 391,
      "name": "Air Electric System"
    },
    {
      "id": 327,
      "name": "Air Filter"
    },
    {
      "id": 353,
      "name": "Air GPS Filter"
    }
  ]
}
```
```

--------------------------------

### GET /api/v3/products.json - sortowanie malejące

Source: https://docs.infakt.pl/

Pobiera listę produktów z sortowaniem malejącym po nazwie, z limitem i offsetem.

```APIDOC
## GET /api/v3/products.json

### Description
Pobiera listę produktów z sortowaniem malejącym po nazwie, z limitem i offsetem.

### Method
GET

### Endpoint
/api/v3/products.json

### Parameters
#### Query Parameters
- **fields** (string) - Required - Lista pól do zwrócenia, np. `name`.
- **offset** (integer) - Required - Przesunięcie wyniku.
- **limit** (integer) - Required - Liczba wyników na stronę.
- **order** (string) - Required - Format: `nazwa_parametru typ_sortowania`, np. `name desc`.

### Request Example
```
GET /api/v3/products.json?fields=name&offset=10&limit=5&order=name desc
```

### Response
#### Success Response (200)
- **metainfo** (object) - Zawiera informacje o liczbie wyników i linki do następnej/poprzedniej strony.
- **entities** (array) - Lista obiektów produktów.

#### Response Example
```json
{
  "metainfo": {
    "count": 3,
    "total_count": 467,
    "next": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=15&limit=5&order=name desc",
    "previous": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=5&limit=5&order=name desc"
  },
  "entities": [
    {
      "id": 137,
      "name": "Video Filter"
    },
    {
      "id": 351,
      "name": "Video Controller"
    },
    {
      "id": 369,
      "name": "Video Compressor"
    }
  ]
}
```
```

--------------------------------

### GET /api/v3/clients.json?q[nip_eq]=SZUKANY_NIP

Source: https://docs.infakt.pl/

Filtruje klientów po NIP równym podanej wartości.

```APIDOC
## GET /api/v3/clients.json?q[nip_eq]=SZUKANY_NIP

### Description
Filtruje klientów po NIP równym podanej wartości.

### Method
GET

### Endpoint
/api/v3/clients.json

### Parameters
#### Query Parameters
- **q[nip_eq]** (string) - Required - NIP klienta do wyszukania.

### Request Example
```bash
curl -H "X-inFakt-ApiKey: API_KEY" \
  -H "Content-Type: application/json" \
  -X GET \
  -d '{"q": {"nip_eq": "SZUKANY_NIP"} }' \
  https://api.infakt.pl/api/v3/clients.json
```

### Response
#### Success Response (200)
- **data** (array) - Lista klientów spełniających kryteria.

#### Response Example
```json
{
  "data": []
}
```
```

--------------------------------

### Example response for invoices with nested fields

Source: https://docs.infakt.pl/

Example JSON response for the invoices request with fields=number,services(name,tax_symbol). The response includes metainfo with pagination links and an entities array containing only the requested fields.

```json
{
  "metainfo": {
      "count": 3,
      "total_count": 15,
      "next": "https://api.infakt.pl/api/v3/invoices.json?fields=number,services(name,tax_symbol)&offset=10",
      "previous": "https://api.infakt.pl/api/v3/invoices.json?fields=number,services(name,tax_symbol)&offset=0"
  },
  "entities": [
    {
      "id": 5,
      "number": "4/05/2022",
      "services": [
        {
          "id": 5,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    },
    {
      "id": 3,
      "number": "3/05/2022",
      "services": [
        {
          "id": 3,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    },
    {
      "id": 2,
      "number": "2/05/2022",
      "services": [
        {
          "id": 2,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /api/v3/invoices.json?fields=number,services(name,tax_symbol)

Source: https://docs.infakt.pl/

Example of requesting a partial response for the invoices list endpoint, including nested fields.

```APIDOC
## GET /api/v3/invoices.json

### Description
Requests a partial response for the invoices list endpoint, returning only the specified fields, including nested fields for services.

### Method
GET

### Endpoint
/api/v3/invoices.json

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in the response. Nested fields can be specified using parentheses. No spaces after commas.

### Request Example
GET /api/v3/invoices.json?fields=number,services(name,tax_symbol)

### Response
#### Success Response (200)
Returns a list of invoices with only the requested fields.

#### Response Example
{
  "metainfo": {
    "count": 3,
    "total_count": 15,
    "next": "https://api.infakt.pl/api/v3/invoices.json?fields=number,services(name,tax_symbol)&offset=10",
    "previous": "https://api.infakt.pl/api/v3/invoices.json?fields=number,services(name,tax_symbol)&offset=0"
  },
  "entities": [
    {
      "id": 5,
      "number": "4/05/2022",
      "services": [
        {
          "id": 5,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    },
    {
      "id": 3,
      "number": "3/05/2022",
      "services": [
        {
          "id": 3,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    },
    {
      "id": 2,
      "number": "2/05/2022",
      "services": [
        {
          "id": 2,
          "name": "kawa",
          "tax_symbol": "23"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /api/v3/invoices.json?q[paid_date_null]=true

Source: https://docs.infakt.pl/

Filtruje faktury bez daty opłacenia.

```APIDOC
## GET /api/v3/invoices.json?q[paid_date_null]=true

### Description
Filtruje faktury bez daty opłacenia.

### Method
GET

### Endpoint
/api/v3/invoices.json

### Parameters
#### Query Parameters
- **q[paid_date_null]** (boolean) - Required - Ustaw na true, aby znaleźć faktury bez daty opłacenia.

### Request Example
```bash
curl -H "X-inFakt-ApiKey: API_KEY" \
  -H "Content-Type: application/json" \
  -X GET \
  -d '{"q": {"paid_date_null": true} }' \
  https://api.infakt.pl/api/v3/invoices.json
```

### Response
#### Success Response (200)
- **data** (array) - Lista faktur spełniających kryteria.

#### Response Example
```json
{
  "data": []
}
```
```

--------------------------------

### GET /api/v3/bank_accounts.json?fields=bank_name

Source: https://docs.infakt.pl/

Example of requesting a partial response for the bank accounts list endpoint using the fields parameter.

```APIDOC
## GET /api/v3/bank_accounts.json

### Description
Requests a partial response for the bank accounts list endpoint, returning only the specified fields.

### Method
GET

### Endpoint
/api/v3/bank_accounts.json

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in the response. No spaces after commas.

### Request Example
GET /api/v3/bank_accounts.json?fields=bank_name

### Response
#### Success Response (200)
Returns a list of bank accounts with only the requested fields.

#### Response Example
{
  "metainfo": {
    "count": 4,
    "total_count": 4,
    "next": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=10",
    "previous": "https://api.infakt.pl/api/v3/bank_accounts.json?fields=bank_name&offset=0"
  },
  "entities": [
    {
      "id": 4,
      "bank_name": "Bank4"
    },
    {
      "id": 3,
      "bank_name": "Bank3"
    },
    {
      "id": 2,
      "bank_name": "Bank2"
    },
    {
      "id": 1,
      "bank_name": "Bank1"
    }
  ]
}
```

--------------------------------

### Request partial response for bank accounts with fields parameter

Source: https://docs.infakt.pl/

Use the fields parameter to request only the specified fields in the response. Multiple fields are separated by commas without spaces. This example requests only the bank_name field.

```http
GET /api/v3/bank_accounts.json?fields=bank_name
```

--------------------------------

### GET /api/v3/invoices.json?q[number_eq]=1/09/2013

Source: https://docs.infakt.pl/

Filtruje faktury po numerze równym podanej wartości.

```APIDOC
## GET /api/v3/invoices.json?q[number_eq]=1/09/2013

### Description
Filtruje faktury po numerze równym podanej wartości.

### Method
GET

### Endpoint
/api/v3/invoices.json

### Parameters
#### Query Parameters
- **q[number_eq]** (string) - Required - Wartość numeru faktury do wyszukania.

### Request Example
```bash
curl -H "X-inFakt-ApiKey: API_KEY" \
  -H "Content-Type: application/json" \
  -X GET \
  -d '{"q": {"number_eq": "1/09/2013"} }' \
  https://api.infakt.pl/api/v3/invoices.json
```

### Response
#### Success Response (200)
- **data** (array) - Lista faktur spełniających kryteria.

#### Response Example
```json
{
  "data": []
}
```
```

--------------------------------

### Przykładowe zapytanie curl: wyszukiwanie klienta po NIP

Source: https://docs.infakt.pl/

Zapytanie GET do /api/v3/clients.json z parametrem q[nip_eq] w celu znalezienia klienta po NIP. Wymaga nagłówka X-inFakt-ApiKey z kluczem API.

```bash
curl -H "X-inFakt-ApiKey: API_KEY" \
  -H "Content-Type: application/json" \
  -X GET \
  -d '{"q": {"nip_eq": "SZUKANY_NIP"} }' \
  https://api.infakt.pl/api/v3/clients.json
```

--------------------------------

### Przykład zapytania sortowania rosnącego (order=name asc)

Source: https://docs.infakt.pl/

Zapytanie GET do API InFakt z parametrem `order=name asc` sortuje wyniki rosnąco. Przykład używa pól `name`, `offset=10`, `limit=5`.

```http
GET /api/v3/products.json?fields=name&offset=10&limit=5&order=name asc
```

--------------------------------

### Example PUT request with JSON body

Source: https://docs.infakt.pl/

Shows a curl command that sends a PUT request to update a client's company name. Requires the API key header and Content-Type: application/json. The request body is a JSON object with a client field.

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

--------------------------------

### Przykład zapytania sortowania malejącego (order=name desc)

Source: https://docs.infakt.pl/

Zapytanie GET do API InFakt z parametrem `order=name desc` sortuje wyniki malejąco. Przykład używa pól `name`, `offset=10`, `limit=5`.

```http
GET /api/v3/products.json?fields=name&offset=10&limit=5&order=name desc
```

--------------------------------

### Przykładowe zapytanie curl: wyszukiwanie faktur bez daty opłacenia

Source: https://docs.infakt.pl/

Zapytanie GET do /api/v3/invoices.json z parametrem q[paid_date_null] ustawionym na true, aby znaleźć faktury bez daty opłacenia. Wymaga nagłówka X-inFakt-ApiKey z kluczem API.

```json
curl -H "X-inFakt-ApiKey: API_KEY" \
  -H "Content-Type: application/json" \
  -X GET \
  -d '{"q": {"paid_date_null": true} }' \
  https://api.infakt.pl/api/v3/invoices.json
```

--------------------------------

### Paginate products with offset and limit

Source: https://docs.infakt.pl/

Use offset and limit query parameters to paginate list endpoints. The limit parameter has a maximum value of 100.

```http
GET /api/v3/products.json?offset=0&limit=100
```

--------------------------------

### Paginate clients with offset and limit

Source: https://docs.infakt.pl/

Use offset and limit query parameters to paginate list endpoints. The limit parameter has a maximum value of 100.

```http
GET /api/v3/clients.json?offset=10&limit=50
```

--------------------------------

### Przykładowa odpowiedź JSON dla sortowania rosnącego

Source: https://docs.infakt.pl/

Odpowiedź JSON dla zapytania z sortowaniem rosnącym. Zawiera metainformacje o liczbie wyników i linki do następnej/poprzedniej strony.

```json
{
  "metainfo": {
      "count": 3,
      "total_count": 467,
      "next": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=15&limit=5&order=name asc"
      "previous": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=5&limit=5&order=name asc"
  },
  "entities": [
    {
      "id": 391,
      "name": "Air Electric System"
    },
    {
      "id": 327,
      "name": "Air Filter"
    },
    {
      "id": 353,
      "name": "Air GPS Filter"
    }
  ]
}
```

--------------------------------

### Przykładowa odpowiedź JSON dla sortowania malejącego

Source: https://docs.infakt.pl/

Odpowiedź JSON dla zapytania z sortowaniem malejącym. Zawiera metainformacje o liczbie wyników i linki do następnej/poprzedniej strony.

```json
{
  "metainfo": {
      "count": 3,
      "total_count": 467,
      "next": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=15&limit=5&order=name desc"
      "previous": "https://api.infakt.pl/api/v3/products.json?fields=name&offset=5&limit=5&order=name desc"
  },
  "entities": [
    {
      "id": 137,
      "name": "Video Filter"
    },
    {
      "id": 351,
      "name": "Video Controller"
    },
    {
      "id": 369,
      "name": "Video Compressor"
    }
  ]
}
```

--------------------------------

### Request partial response for invoices with nested fields

Source: https://docs.infakt.pl/

Use the fields parameter to request only the specified fields, including nested fields for services. Multiple fields are separated by commas without spaces.

```http
GET /api/v3/invoices.json?fields=number,services(name,tax_symbol)
```
Tokens:
Raw