API Aviz de expediție

Gestionarea avizelor de expediție de ieșire — preluare, creare, modificare, închidere și descărcare document

URL de bază

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

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

GET /api/delivery_note_out/get

Preluarea unui singur aviz de expediție de ieșire pe baza identificatorului, cu detalii complete.

Parametri query

ParametruTipObligatoriuDescriere
idintIdentificatorul unic al avizului de expediție

Exemplu de cerere

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

Preluarea paginabilă a listei avizelor de expediție de ieșire, cu posibilități de filtrare.

Parametri query

ParametruTipObligatoriuDescriere
list_offsetintDecalajul pentru paginare (implicit: 0)
list_countintNumărul de înregistrări afișate pe pagină
list_condition[identify]stringFiltrare după identificator (LIKE)
list_condition[company_name]stringFiltrare după numele partenerului (LIKE)
list_condition[status_id]intFiltrare după status
list_condition[date_create_from]dateData creării — de la (YYYY-MM-DD)
list_condition[date_create_to]dateData creării — până la (YYYY-MM-DD)

Exemplu de cerere

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

Creare sau modificare aviz de expediție de ieșire. Pentru o înregistrare nouă data[id] = 0.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
idint0 = aviz nou, >0 = modificare
company_idintIdentificatorul companiei
company_user_idintID-ul angajatului responsabil
company_address_idintID-ul punctului de lucru al companiei
currency_idintIdentificatorul monedei
partner_idintIdentificatorul partenerului/clientului
partner_shipping_idintID-ul adresei de livrare a partenerului
date_performdateData livrării (YYYY-MM-DD)
comment_topstringObservație vizibilă clientului
comment_bottomstringObservație internă
jobnumber_idintIdentificatorul numărului de lucrare
itemarrayTabloul pozițiilor (vezi mai jos)

Câmpurile poziției — data[item][]

CâmpTipObligatoriuDescriere
product_idintIdentificatorul produsului
quantityfloatCantitate
pricefloatPreț unitar net
tax_idintIdentificatorul cotei de TVA
store_idintIdentificatorul depozitului
removeint1 = ștergerea poziției la modificare

Exemplu de cerere

POST /api/delivery_note_out/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,
    "currency_id": 1,
    "partner_id": 12,
    "date_perform": "2024-06-20",
    "item": [
      { "product_id": 5, "quantity": 3, "price": 12000, "tax_id": 2 }
    ]
  }
}
POST /api/delivery_note_out/delete

Ștergerea unui aviz de expediție de ieșire. Se poate șterge doar un aviz cu status deschis.

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
receipt_idintIdentificatorul avizului de șters

Exemplu de cerere

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

{ "data": { "receipt_id": 22 } }
POST /api/delivery_note_out/close

Închiderea unui aviz de expediție de ieșire. Se poate închide doar un aviz deschis (status_id=1).

Câmpuri POST — obiectul data

CâmpTipObligatoriuDescriere
receipt_idintIdentificatorul avizului de închis

Exemplu de cerere

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

{ "data": { "receipt_id": 22 } }
GET /api/delivery_note_out/download

Descărcarea documentului avizului de expediție de ieșire în diverse formate.

Parametri query

ParametruTipObligatoriuDescriere
receipt_idintIdentificatorul avizului
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringNumele folderului de limbă al șablonului
template_idintID șablon de tipărire personalizat

Exemplu de cerere

GET /api/delivery_note_out/download?receipt_id=22&file_type=pdf
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!