Registrácia Prihlásenie

API súboru dokladu

Správa súborov priložených k dokladom — nahrávanie, získavanie a odstraňovanie

Koncové body

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.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Súbor dokladu je binárny súbor priložený k dokladu (faktúra, objednávka, zmluva atď.) — uložený s obsahom kódovaným v base64.

GET /api/receipt_file/get

Získanie jedného súboru dokladu podľa identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor záznamu súboru

Príklad požiadavky

GET /api/receipt_file/get?id=10
X-API-KEY: {vas_api_kluc}
GET /api/receipt_file/list

Stránkovateľný zoznam súborov dokladov s možnosťou filtrovania.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_condition[receipt_id]intFiltrovanie podľa identifikátora dokladu
list_condition[receipt_type_id]intFiltrovanie podľa typu dokladu
list_condition[partner_id]intFiltrovanie všetkých súborov dokladov partnera

Príklad požiadavky

GET /api/receipt_file/list?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {vas_api_kluc}
GET /api/receipt_file/list_light

Odľahčený zoznam súborov dokladov — bez obsahu súboru (file_source), iba s metaúdajmi.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectFiltrovacie podmienky (rovnako ako pri koncovom bode /list)

Príklad požiadavky

GET /api/receipt_file/list_light?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {vas_api_kluc}
POST /api/receipt_file/save

Nahratie súboru alebo úprava existujúceho. Pre nový súbor data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový súbor, >0 = úprava
receipt_type_idintIdentifikátor typu dokladu
receipt_idintIdentifikátor dokladu
file_namestringNázov súboru s príponou (napr. szamla.pdf)
file_sourcestringObsah súboru kódovaný v base64
file_type_idintIdentifikátor typu súboru (predvolené: 1)
file_classification_idintIdentifikátor klasifikácie súboru

Príklad požiadavky

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

{
  "data": {
    "id": 0,
    "receipt_type_id": 8,
    "receipt_id": 150,
    "file_name": "szamla_150.pdf",
    "file_source": "JVBERi0x..."
  }
}
POST /api/receipt_file/delete

Odstránenie súboru dokladu podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor súboru, ktorý sa má odstrániť

Príklad požiadavky

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

{ "data": { "id": 10 } }

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!
Vytvorenie registrácie
Registrácia