API Inventariere

Gestionarea fișelor de inventar — preluare, creare, modificare, închidere, descărcare document și interogări la nivel de articol

URL-uri de bază

https://{tenant}.logzi.com/api/inventory/ https://{tenant}.logzi.com/api/inventory_item/

Fiecare cerere returnează un răspuns JSON. În caz de succes, result.code == 1, iar în caz de eroare, result.code == 0.

GET /api/inventory/get

Preluarea unei singure fișe de inventar pe baza identificatorului, împreună cu liniile de articole aferente.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
id int Identificatorul unic al fișei de inventar

Exemplu de cerere

GET /api/inventory/get?id=5
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 5,
    "identify": "INV-2024-0005",
    "date_create": "2024-05-08 09:00:00",
    "date_perform": "2024-05-08",
    "status_id": 1,
    "store_id": 1,
    "company_user_name": "Kovács Péter",
    "item": [
      {
        "product_id": 12,
        "quantity_stock": 100,
        "quantity_found": 97,
        "store_locality_id": null
      }
    ]
  }
}
GET /api/inventory/list

Preluarea paginată a listei de fișe de inventar, cu opțiuni de filtrare.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
list_offset int Decalajul paginării (implicit: 0)
list_condition[identify] string Filtrare după identificator (LIKE)
list_condition[status_id] int Filtrare după status (1=deschis, 2=închis)
list_condition[status_ids] array Filtrare după mai multe statusuri simultan
list_condition[company_user_id] int Filtrare după ID-ul angajatului responsabil
list_condition[date_create_from] date Data creării — de la (YYYY-MM-DD)
list_condition[date_create_to] date Data creării — până la (YYYY-MM-DD)
list_condition[date_perform_from] date Data îndeplinirii — de la (YYYY-MM-DD)
list_condition[date_perform_to] date Data îndeplinirii — până la (YYYY-MM-DD)
list_condition[comment_bottom] string Filtrare după observația internă (LIKE)

Exemplu de cerere

GET /api/inventory/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 5,
      "identify": "INV-2024-0005",
      "date_create": "2024-05-08",
      "status_name": "Nyitott",
      "company_user_name": "Kovács Péter"
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 3
  }
}
POST /api/inventory/save

Crearea sau modificarea unei fișe de inventar. Pentru fiecare articol trebuie înregistrată cantitatea din evidență (quantity_stock) și cantitatea numărată fizic (quantity_found). Pentru o fișă de inventar nouă, data[id] = 0.

Câmpuri POST — data obiect

Câmp Tip Obligatoriu Descriere
id int 0 = fișă de inventar nouă, >0 = modificare
company_id int Identificatorul companiei
company_user_id int ID-ul angajatului responsabil
store_id int Identificatorul depozitului care urmează a fi inventariat
currency_id int Identificatorul valutei
currency_exchange decimal Curs valutar
project_id int Identificatorul proiectului
source_receipt_id int Identificatorul documentului sursă
source_receipt_type_id int Identificatorul tipului documentului sursă
item array Tabloul de articole — este obligatoriu cel puțin un articol (vezi mai jos)

Câmpuri articol — data[item][]

Câmp Tip Obligatoriu Descriere
id int 0 = articol nou, >0 = modificarea unui articol existent
product_id int Identificatorul produsului
quantity_stock decimal Cantitatea din evidență (conform sistemului)
quantity_found decimal Cantitatea numărată fizic
store_locality_id int Identificatorul locației de stocare
remove int 1 = ștergerea articolului la modificare

Câmpuri POST — params obiect (opțional)

Câmp Tip Obligatoriu Descriere
close int 1 = închidere automată după salvare

Exemplu de cerere

POST /api/inventory/save
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "store_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 12,
        "quantity_stock": 100,
        "quantity_found": 97
      },
      {
        "id": 0,
        "product_id": 15,
        "quantity_stock": 50,
        "quantity_found": 50,
        "store_locality_id": 3
      }
    ]
  },
  "params": {
    "close": 0
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 6,
    "identify": "INV-2024-0006"
  }
}
POST /api/inventory/delete

Ștergerea unei fișe de inventar. Se poate șterge doar un document cu status_id = 1 (deschis) sau status_id = 2 (închis).

Câmpuri POST — data obiect

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul fișei de inventar care urmează a fi ștearsă

Exemplu de cerere

POST /api/inventory/delete
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "receipt_id": 5
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/inventory/close

Închiderea unei fișe de inventar deschise. Închiderea efectuează regularizarea stocului pe baza diferenței dintre valorile quantity_stock și quantity_found. Se poate închide doar un document cu status_id = 1 (deschis).

Câmpuri POST — data obiect

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul fișei de inventar care urmează a fi închisă

Exemplu de cerere

POST /api/inventory/close
X-API-KEY: {cheia_dvs_api}
Content-Type: application/json

{
  "data": {
    "receipt_id": 5
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/inventory/download

Generarea documentului fișei de inventar în diverse formate (PDF, string base64, stream).

Parametri de interogare

Parametru Tip Obligatoriu Descriere
receipt_id int Identificatorul fișei de inventar
file_type string Formatul de ieșire (vezi mai jos)
language string Numele folderului de limbă al șablonului (ex. hungarian)
language_id int Identificatorul limbii (implicit: 1)
template_id int ID șablon de tipărire personalizat

Valori posibile pentru file_type

Valoare Descriere
pdf Returnarea unui PDF codat base64, cu metadate
pdf-string Identic cu pdf — string base64 + metadate
pdf-string-sample Generare PDF de previzualizare
stream Stream direct de fișier (descărcare din browser)

Exemplu de cerere

GET /api/inventory/download?receipt_id=5&file_type=pdf
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "INV-2024-0005.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Endpoint-uri linii articol

Endpoint-urile /api/inventory_item/ servesc la interogarea detaliată a articolelor unei anumite fișe de inventar. Scrierea și ștergerea articolelor se realizează prin salvarea fișei de inventar (/api/inventory/save).

GET /api/inventory_item/get

Preluarea unui singur articol din fișa de inventar, pe baza identificatorului.

Parametru Tip Obligatoriu Descriere
id int Identificatorul unic al articolului din fișa de inventar

Exemplu de cerere

GET /api/inventory_item/get?id=88
X-API-KEY: {cheia_dvs_api}
GET /api/inventory_item/list

Preluarea tuturor articolelor unei fișe de inventar.

Parametru Tip Obligatoriu Descriere
inventory_sheet_id int Identificatorul fișei de inventar

Exemplu de cerere

GET /api/inventory_item/list?inventory_sheet_id=5
X-API-KEY: {cheia_dvs_api}
GET /api/inventory_item/list_tax

Însumarea articolelor unei fișe de inventar pe cote de TVA.

Parametru Tip Obligatoriu Descriere
inventory_sheet_id int Identificatorul fișei de inventar

Exemplu de cerere

GET /api/inventory_item/list_tax?inventory_sheet_id=5
X-API-KEY: {cheia_dvs_api}
GET /api/inventory_item/list_slim

Preluarea paginată și filtrabilă a articolelor din fișa de inventar — filtrabile inclusiv după depozit și status.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
list_offset int Decalajul paginării (implicit: 0)
list_condition[inventory_sheet_id] int Filtrare după ID-ul fișei de inventar
list_condition[store_id] int Filtrare după ID-ul depozitului
list_condition[status_id] int Filtrare după statusul fișei de inventar

Exemplu de cerere

GET /api/inventory_item/list_slim?list_condition[inventory_sheet_id]=5&list_offset=0
X-API-KEY: {cheia_dvs_api}

Ia legătura cu noi

Ești interesat de software-ul nostru? Scrie-ne cu încredere!

Ai nevoie de ajutor?

Dacă nu găsești răspunsul și ai nevoie de asistență

Creează-ți contul acum,
plătește mai târziu!

Încearcă gratuit timp de 3 zile, fără riscuri și fără obligații!