Registrácia Prihlásenie

API vyrovnaní

Správa vyrovnaní dokladov — získavanie, evidovanie a odstraňovanie finančných plnení priradených k faktúram a pokladničným dokladom

Koncové body

GET Získanie záznamu
GET Získanie zoznamu
POST Uloženie / evidovanie
POST Odstránenie

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Vyrovnanie je evidencia finančného plnenia dokladu (faktúry alebo pokladničného dokladu).

GET /api/compensate/get

Získanie jedného vyrovnania na základe identifikátora, spolu s údajmi súvisiaceho dokladu.

Query parametre

Parameter	Typ	Povinné	Popis
`id`	int		Jedinečný identifikátor vyrovnania

Príklad požiadavky

GET /api/compensate/get?id=55
X-API-KEY: {vas_api_kluc}

GET /api/compensate/list

Získanie stránkovaného zoznamu vyrovnaní s možnosťami filtrovania.

Query parametre

Parameter	Typ	Popis
`list_offset`	int	Posun stránkovania (predvolene: 0)
`list_condition[search_text]`	string	Voľné textové vyhľadávanie podľa čísla dokladu a názvu partnera
`list_condition[partner_company_name]`	string	Filtrovanie podľa názvu partnera (LIKE)
`list_condition[receipt_identify]`	string	Filtrovanie podľa čísla dokladu (LIKE)
`list_condition[invoice_receipt_type_id]`	int	Filtrovanie podľa typu dokladu
`list_condition[invoice_receipt_id]`	int	Filtrovanie podľa identifikátora dokladu
`list_condition[company_id]`	int	Identifikátor firmy (predvolene: 1)

Príklad požiadavky

GET /api/compensate/list?list_offset=0&list_condition[partner_company_name]=Minta
X-API-KEY: {vas_api_kluc}

POST /api/compensate/save

Evidovanie vyrovnania k existujúcemu dokladu (faktúre alebo pokladničnému dokladu). Doklad je možné identifikovať číslom dokladu, číslom objednávky zákazníka alebo e-mailovou adresou.

POST polia — objekt data

Pole	Typ	Popis
`receipt_id`	int	0 = nové vyrovnanie (s existujúcim identifikátorom), >0 = úprava
`amount`	float	Vyrovnaná suma
`company_user_id`	int	Identifikátor zamestnanca, ktorý vyrovnanie zaevidoval
`identify_invoice`	string	Číslo dokladu faktúry (ak hľadáme podľa faktúry)
`identify_customer`	string	Číslo objednávky zákazníka (ak hľadáme podľa objednávky)
`customer_email`	string	E-mailová adresa zákazníka (ak hľadáme podľa e-mailu)
`parcel_number`	string	Číslo zásielky (ak hľadáme podľa zásielky)

Príklad požiadavky

POST /api/compensate/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "receipt_id": 0,
    "amount": 127000,
    "company_user_id": 3,
    "identify_invoice": "2024/00123"
  }
}

POST /api/compensate/delete

Odstránenie vyrovnania. Po odstránení sa súvisiaci doklad opäť považuje za otvorený.

POST polia — objekt data

Pole	Typ	Povinné	Popis
`receipt_id`	int		Identifikátor vyrovnania, ktoré sa má odstrániť

Príklad požiadavky

POST /api/compensate/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "receipt_id": 55 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!

Registrácia