Înregistrare Autentificare

API parametru document

Gestionarea valorilor parametrilor atribuite documentelor - obținere, listă și salvare

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/

Fiecare cerere returnează un răspuns JSON. În cazul unui răspuns cu succes result.code == 1, în caz de eroare result.code == 0. O înregistrare stochează valoarea unui singur parametru aferent unui document; structura parametrului este descrisă de API schemă parametru document.

GET /api/receipt_param/get

Obținerea valorii unui singur parametru de document. Căutarea se face după identificatorul schemei parametrului și/sau identificatorul documentului, iar dintre rândurile găsite este returnat primul. Specificarea cel puțin a unuia dintre parametri este obligatorie, în caz contrar răspunsul este Not found.

Parametri de interogare

Parametru Tip Obligatoriu Descriere
param_schema_id int Identificatorul schemei parametrului (cel puțin acesta sau receipt_id este obligatoriu)
receipt_id int Identificatorul documentului (cel puțin acesta sau param_schema_id este obligatoriu)

Exemplu de cerere

GET /api/receipt_param/get?param_schema_id=3&receipt_id=42
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 17,
    "param_schema_id": 3,
    "param_value": "125.5",
    "receipt_type_id": 1,
    "receipt_id": 42
  }
}
GET /api/receipt_param/list

Lista valorilor parametrilor de document. Lista nu este paginată, rezultatele sosesc într-un singur tablou. Fără filtrare returnează toate înregistrările.

Parametri de interogare

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

Exemplu de cerere

GET /api/receipt_param/list?list_condition[receipt_id]=42
X-API-KEY: {cheia_dvs_api}

Exemplu de răspuns

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 17,
      "param_schema_id": 3,
      "param_value": "125.5",
      "receipt_type_id": 1,
      "receipt_id": 42
    },
    {
      "id": 18,
      "param_schema_id": 4,
      "param_value": "Urgent",
      "receipt_type_id": 1,
      "receipt_id": 42
    }
  ]
}
POST /api/receipt_param/save

Salvarea valorii unui parametru de document. Dacă pentru documentul și schema de parametru respective există deja o înregistrare (param_schema_id + receipt_id), salvarea o modifică, în caz contrar creează o înregistrare nouă. Răspunsul conține identificatorul înregistrării.

Câmpuri POST - obiectul data

Câmp Tip Obligatoriu Descriere
param_schema_id int Identificatorul schemei parametrului (mai mare ca 0)
receipt_id int Identificatorul documentului (mai mare ca 0)
receipt_type_id int Identificatorul tipului de document
param_value string Valoarea parametrului ca text (maximum 1500 de caractere). În funcție de tipul param_type_id al schemei, poate fi număr, text, valoare logică sau element dintr-o listă de valori.

Exemplu de cerere

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

{
  "data": {
    "param_schema_id": 3,
    "receipt_id": 42,
    "receipt_type_id": 1,
    "param_value": "125.5"
  }
}

Exemplu de răspuns

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

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