Produkty
Zarządzanie produktami należącymi do użytkownika
Definicja
Obiekt Product
zawiera następujące klucze:
Parametr | Typ danych | Wymagany | Opis |
---|---|---|---|
id | integer | Tylko do odczytu | ID Produktu |
name | string | Tak | Nazwa |
symbol | string | Nie | PKWiU / CN / PKOB deprecated |
pkwiu | string | Nie | PKWiU |
cn | string | Nie | CN |
pkob | string | Nie | PKOB |
unit | string | Nie | Jednostka miary |
tax_symbol | string | Tak | Stawka VAT (lista obsługiwanych stawek) |
quantity | integer | Nie | Ilość |
net_price | integer | Nie | Wartość netto w groszach |
tax_price | integer | Nie | Podatek w groszach |
gross_price | integer | Nie | Wartość brutto w groszach |
unit_net_price | integer | Nie | Cena jednostkowa zakupu netto w groszach |
purchase_unit_net_price | integer | Nie | Cena zakupu netto w groszach |
purchase_unit_gross_price | integer | Nie | Cena zakupu brutto w groszach |
flat_rate_tax_symbol | string | W przypadku korzystania z ryczałtu ewidencjonowanego | Dostępne stawki: 2 , 3 , 5.5 , 8.5 , 17 , 20 (lista obsługiwanych stawek) |
discount | integer | Nie | Wartość rabatu w procentach |
unit_net_price_before_discount | integer | Nie | Cena zakupu netto w groszach przed rabatem |
gtu_id | integer | Nie | Id kodu GTU (Oznaczenia dostaw towarów i świadczenia usług) |
Listowanie produktów
GET /v3/products.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 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/products.json
Przykładowa odpowiedź
{
"metainfo": {
"count": 10,
"total_count": 10,
"next": "https://api.infakt.pl/api/v3/products.json?offset=10",
"previous": "https://api.infakt.pl/api/v3/products.json?offset=0"
},
"entities": [{
"id": 42,
"name": "Usługa 1",
...
}, {
"id": 43,
"name": "Produkt 2",
...
}]
}
Możliwe kody odpowiedzi:
Kod odpowiedzi | Opis |
---|---|
200 | Zapytanie zostało wykonane poprawnie |
401 | Brak autoryzacji lub uprawnień do danego zasobu |
Podgląd produktu
GET /v3/products/{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/products/42.json
Przykładowa odpowiedź
{
"id": 42,
"name": "Usługa 1",
"symbol": "84.11.12.0/ / ",
"pkwiu": "84.11.12.0",
"cn": "",
"pkob": "",
"unit": "",
"tax_symbol": "23",
"quantity": 1,
...
}
Możliwe kody odpowiedzi:
Kod odpowiedzi | Opis |
---|---|
200 | Zapytanie zostało wykonane poprawnie |
401 | Brak autoryzacji lub uprawnień do danego zasobu |
Tworzenie
POST /v3/products.json
Tworzenie
curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
-H "Content-Type: application/json" \
-X POST
-d '{"product":{
"name": "Usługa x",
"unit": "szt.",
"net_price": "40000",
"tax_price": "9200",
"gross_price": "49200",
"tax_symbol": "23",
...
}}' \
https://api.infakt.pl/v3/products.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 produktu
PUT /v3/products/{id}.json
Aktualizacja
curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
-H "Content-Type: application/json" \
-X PUT \
-d '{"product":{
"name": "Produkt xy",
"purchase_unit_net_price": "3500",
"purchase_unit_gross_price": "43050",
...
}}' \
https://api.infakt.pl/v3/products/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 produktu
DELETE /v3/products/{id}.json
Usuwanie
curl -H "X-inFakt-ApiKey: 49206c6f766520496e66616b74203a3e" \
-X DELETE \
https://api.infakt.pl/v3/products/1.json
Możliwe kody odpowiedzi:
Kod odpowiedzi | Opis |
---|---|
204 | Zwracany po poprawnym usunięciu zasobu. |
401 | Brak autoryzacji lub uprawnień do danego zasobu |