Základná URL
https://{tenant}.logzi.com/api/cash/
Bankový doklad sa spravuje prostredníctvom API pokladničného dokladu (/api/cash/). Bankové a pokladničné doklady používajú rovnaký koncový bod — rozlíšenie sa vykonáva na základe cashstock_id: je potrebné zadať identifikátor pokladničnej zásoby priradenej k bankovému účtu. V prípade úspešnej odpovede je result.code == 1, v prípade chyby result.code == 0.
/api/cash/get
Načítanie jedného bankového dokladu podľa identifikátora, spolu s položkou a súvisiacimi dokladmi.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Jedinečný identifikátor bankového dokladu |
Príklad požiadavky
GET /api/cash/get?id=88
X-API-KEY: {vas_api_kluc}
/api/cash/list
Stránkovateľné načítanie zoznamu bankových dokladov s možnosťami filtrovania.
Parametre dotazu
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolene: 0) | |
list_count | int | Počet záznamov zobrazených na stránku | |
list_condition[identify] | string | Filtrovanie podľa čísla dokladu (LIKE) | |
list_condition[partner_name] | string | Filtrovanie podľa názvu partnera (LIKE) | |
list_condition[cashstock_id] | int | Filtrovanie podľa identifikátora bankového účtu / pokladničnej zásoby | |
list_condition[type_id] | int | Filtrovanie podľa typu dokladu (príjem / výdaj) | |
list_condition[date_create_from] | date | Dátum vytvorenia — od (YYYY-MM-DD) | |
list_condition[date_create_to] | date | Dátum vytvorenia — do (YYYY-MM-DD) |
Príklad požiadavky
GET /api/cash/list?list_offset=0&list_condition[cashstock_id]=2
X-API-KEY: {vas_api_kluc}
/api/cash/save
Vytvorenie alebo úprava bankového dokladu. Hodnota cashstock_id určuje, či vznikne pokladničný alebo bankový doklad. Pre nový doklad zadajte data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový doklad, >0 = úprava | |
company_id | int | Identifikátor firmy | |
company_user_id | int | ID zodpovedného pracovníka | |
cashstock_id | int | Identifikátor bankového účtu / pokladničnej zásoby | |
receipt_type_id | int | Typ dokladu (príjem / výdaj) | |
currency_id | int | Identifikátor meny | |
partner_id | int | Identifikátor partnera | |
date_perform | date | Dátum plnenia / valuty (YYYY-MM-DD) | |
price_brutto | float | Suma dokladu (brutto) | |
comment_top | string | Poznámka / správa pre príjemcu | |
item | array | Súvisiace položky dokladu (napr. odkaz na faktúru) |
Príklad požiadavky
POST /api/cash/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"company_user_id": 3,
"cashstock_id": 2,
"receipt_type_id": 27,
"currency_id": 1,
"partner_id": 8,
"date_perform": "2024-07-01",
"price_brutto": 127000,
"comment_top": "Számla kiegyenlítés"
}
}
/api/cash/delete
Vymazanie bankového dokladu. Vymazať možno len neuzavretý doklad.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
receipt_id | int | Identifikátor bankového dokladu, ktorý sa má vymazať |
Príklad požiadavky
POST /api/cash/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "receipt_id": 88 } }
Zaregistruj sa teraz,
zaplať neskôr!