API Ieșire din depozit

Gestionarea ieșirilor din depozit — preluare, creare, modificare, închidere și descărcare document

URL de bază

https://{tenant}.logzi.com/api/outgoing/

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

GET /api/outgoing/get

Obținerea unei singure ieșiri din depozit pe baza identificatorului, cu detalii complete (articole, numere de serie, proiect).

Parametri de interogare

Parametru Tip Obligatoriu Descriere
id int Identificatorul unic al ieșirii din depozit
item_params[include_pictures] int 1 = returnează imaginile produselor la articole
item_params[include_items_stock_serial] int 1 = returnează datele privind numerele de serie
item_params[include_items_product_parts] int 1 = returnează componentele produsului
item_params[include_receipt_cr] int 1 = returnează documentele conectate

Exemplu de cerere

GET /api/outgoing/get?id=17&item_params[include_items_stock_serial]=1
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 17,
    "identify": "OUT-2024-0017",
    "date_create": "2024-05-03 11:20:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_brutto": 63500,
    "price_netto": 50000,
    "price_tax": 13500,
    "currency_name": "HUF",
    "item": [
      {
        "product_id": 5,
        "quantity": 2,
        "price": 25000,
        "price_brutto": 31750
      }
    ]
  }
}
GET /api/outgoing/list

Preluarea paginată a listei de ieșiri din depozit, cu opțiuni de filtrare și sortare.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
list_offset int Decalajul paginării (implicit: 0)
list_count int Numărul de rezultate pe pagină (implicit: 10)
list_condition[identify] string Filtrare după identificator (LIKE)
list_condition[company_name] string Filtrare după numele partenerului (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[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 de finalizare — de la (YYYY-MM-DD)
list_condition[date_perform_to] date Data de finalizare — până la (YYYY-MM-DD)
list_condition[partner_id] int Filtrare după ID-ul partenerului
list_condition[company_user_id] int Filtrare după ID-ul angajatului responsabil
list_condition[partnumber] string Filtrare după cod produs sau cod de bare (LIKE)
list_condition[serial_number] string Filtrare după numărul de serie
list_sort[field] string Numele câmpului de sortare
list_sort[sort] string ASC sau DESC

Exemplu de cerere

GET /api/outgoing/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": 17,
      "identify": "OUT-2024-0017",
      "date_create": "2024-05-03",
      "status_name": "Nyitott",
      "partner_company_name": "Minta Kft.",
      "price_brutto": 63500
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 34
  }
}
POST /api/outgoing/save

Crearea sau modificarea unei ieșiri din depozit. Pentru o ieșire nouă data[id] = 0, pentru modificare specificați ID-ul existent.

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
id int 0 = ieșire din depozit nouă, >0 = modificare
company_id int Identificatorul companiei
company_user_id int ID-ul angajatului responsabil
company_address_id int ID-ul sediului companiei
date_perform datetime Data de finalizare (YYYY-MM-DD HH:MM:SS)
currency_id int Identificatorul monedei
partner_id int Identificatorul partenerului/clientului
partner_user_id int ID-ul persoanei de contact a partenerului
partner_shipping_id int ID-ul adresei de livrare a partenerului
currency_exchange decimal Cursul valutar (implicit: 1)
comment_top string Comentariu vizibil pentru client
comment_bottom string Comentariu intern
jobnumber_id int Identificatorul numărului de lucrare
departmentnumber_id int Identificatorul numărului de departament
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âmpurile articolului — data[item][]

Câmp Tip Obligatoriu Descriere
id int 0 = articol nou, >0 = modificarea unui articol existent
product_id int Identificatorul produsului
store_id int Identificatorul depozitului
store_locality_id int Identificatorul locației de stocare
quantity decimal Cantitate
tax_id int Identificatorul cotei de TVA
price decimal Preț unitar net
price_discount decimal Procentul de reducere/adaos
stock_change int Indicator de mișcare a stocului
comment_top string Comentariu asociat articolului
remove int 1 = ștergerea articolului la modificare

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

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

Exemplu de cerere

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

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "date_perform": "2024-06-15 09:00:00",
    "partner_id": 12,
    "currency_id": 1,
    "item": [
      {
        "id": 0,
        "product_id": 5,
        "store_id": 1,
        "quantity": 2,
        "tax_id": 2,
        "price": 25000
      }
    ]
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 18,
    "identify": "OUT-2024-0018"
  }
}
POST /api/outgoing/delete

Ștergerea unei ieșiri din depozit. Poate fi șters doar un document cu status_id = 1 (deschis) sau status_id = 2 (închis).

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul ieșirii din depozit care urmează să fie ștearsă

Exemplu de cerere

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

{
  "data": {
    "receipt_id": 17
  }
}

Exemplu de răspuns

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

Închiderea unei ieșiri din depozit deschise. Efectuează mișcarea de stoc și validarea cantității pentru produsele gestionate în stocul de depozit. Poate fi închis doar un document cu status_id = 1 (deschis).

Câmpuri POST — obiectul data

Câmp Tip Obligatoriu Descriere
receipt_id int Identificatorul ieșirii din depozit care urmează să fie închisă

Exemplu de cerere

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

{
  "data": {
    "receipt_id": 17
  }
}

Exemplu de răspuns

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

Generarea documentului ieșirii din depozit în diferite formate (PDF, șir base64, stream).

Parametri de interogare

Parametru Tip Obligatoriu Descriere
receipt_id int Identificatorul ieșirii din depozit
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-ul șablonului de tipărire personalizat

Valori posibile pentru file_type

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

Exemplu de cerere

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

Exemplu de răspuns (file_type=pdf)

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

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!