Înregistrare Autentificare

API schemă parametru document

Gestionarea schemei parametrilor personalizați aferenți tipurilor de documente - obținere, listă, salvare și ștergere

Endpoint-uri

Autentificare

Fiecare cerere API necesită trimiterea header-ului X-API-KEY.

X-API-KEY: {cheia_dvs_api}

Mai ai întrebări?

Trimite-ne un tichet, sau caută în motorul nostru de căutare.

Dacă ți-a plăcut, distribuie-l și altora

URL de bază

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

Fiecare cerere returnează un răspuns JSON. În cazul unui răspuns cu succes result.code == 1, în caz de eroare result.code == 0. Schema determină ce parametri personalizați aparțin unui tip de document (denumire, tip, unitate de măsură, ordine). Valorile concrete ale parametrilor sunt gestionate de API parametru document.

Valori posibile pentru param_type_id

Valoare Denumire Descriere
1 Număr Valoare numerică, opțional cu unitate de măsură (param_unit_id)
2 Text Valoare text liberă
3 Logic Valoare da / nu
4 Listă de valori Se poate alege dintre valorile posibile predefinite (param_enum)
GET /api/receipt_param_schema/get

Obținerea unei singure scheme de parametru de document pe baza identificatorului. Schemele șterse (remove = 1) nu sunt returnate.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
id int Identificatorul unic al schemei parametrului

Exemplu de cerere

GET /api/receipt_param_schema/get?id=3
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 3,
    "receipt_type_id": 1,
    "param_type_id": 1,
    "param_name": "Greutate brută",
    "param_enum": null,
    "param_order": 1,
    "param_unit_id": 4,
    "remove": 0
  }
}
GET /api/receipt_param_schema/list

Lista schemelor de parametri de document (fără schemele șterse), ordonată după tipul de document, ordinea de afișare și identificator. Lista nu este paginată. Pe lângă câmpurile schemelor, răspunsul conține și denumirea tipului de parametru, a tipului de document și a unității de măsură.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
list_condition[receipt_type_id] int Filtrare după identificatorul tipului de document

Exemplu de cerere

GET /api/receipt_param_schema/list?list_condition[receipt_type_id]=1
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 3,
      "receipt_type_id": 1,
      "param_type_id": 1,
      "param_name": "Greutate brută",
      "param_enum": null,
      "param_order": 1,
      "param_unit_id": 4,
      "remove": 0,
      "param_type_name": "Număr",
      "receipt_type_name": "Intrare în depozit",
      "unit_name_short": "kg"
    },
    {
      "id": 4,
      "receipt_type_id": 1,
      "param_type_id": 4,
      "param_name": "Prioritate",
      "param_enum": "[\"Scăzută\",\"Normală\",\"Urgent\"]",
      "param_order": 2,
      "param_unit_id": null,
      "remove": 0,
      "param_type_name": "Listă de valori",
      "receipt_type_name": "Intrare în depozit",
      "unit_name_short": null
    }
  ]
}
POST /api/receipt_param_schema/save

Crearea sau modificarea unei scheme de parametru de document. Pentru o schemă nouă se specifică data[id] = 0, pentru modificare se specifică identificatorul existent.

Câmpuri POST - obiectul data

Câmp Tip Obligatoriu Descriere
id int 0 = schemă nouă, >0 = modificare
receipt_type_id int Identificatorul tipului de document de care aparține parametrul
param_type_id int Tipul parametrului (1 = număr, 2 = text, 3 = logic, 4 = listă de valori)
param_name string Denumirea parametrului (maximum 150 de caractere)
param_enum array Tabloul valorilor selectabile. Se salvează doar pentru param_type_id = 4 (stocat ca JSON, maximum 1000 de caractere), pentru alte tipuri sistemul îl ignoră.
param_order int Ordinea de afișare (implicit: 0)
param_unit_id int Identificatorul unității de măsură. Pentru valoarea 0 sau goală nu există unitate de măsură.

Exemplu de cerere

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

{
  "data": {
    "id": 0,
    "receipt_type_id": 1,
    "param_type_id": 4,
    "param_name": "Prioritate",
    "param_enum": ["Scăzută", "Normală", "Urgent"],
    "param_order": 2
  }
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 4
  }
}
POST /api/receipt_param_schema/delete

Ștergerea unei scheme de parametru de document pe baza identificatorului. Ștergerea este logică: schema primește marcajul remove = 1, după care interogările nu o mai returnează.

Câmpuri POST

Câmp Tip Obligatoriu Descriere
id int Identificatorul schemei de parametru de șters

Exemplu de cerere

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

{
  "id": 4
}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}

Ia legătura cu noi

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

Trimite o solicitare

Ai nevoie de ajutor?

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

Răsfoiește centrul de ajutor

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

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