Preskoči na glavno vsebino

Súhrnné informácie o firme v adresári cez REST API

Ako získať informácie o obchodnom partnerovi pomocou REST API Flexi

Avtor: Petr Pech

V aplikácii sú na vybranom adresárovom zázname dostupné súhrnné informácie pod záložkou Súhrnné informácie — celková fakturovaná suma, nezaplatená suma, splatnosť a podobne. Tá istá štatistika finančnej bilancie s obchodným partnerom je dostupná aj v REST API.


Zostavenie URL

Požiadavka sa zasiela metódou GET na subevidenciu summary konkrétneho záznamu z adresára:

GET https://demo.flexibee.eu/c/demo/adresar/123/summary.json
GET https://demo.flexibee.eu/c/demo/adresar/code:ABRA/summary.xml

⚠️ Firmu možno adresovať číselným ID alebo identifikátorom code:ZKRATKA. Filtrácia v okrúhlych zátvorkách tu nefunguje — dotaz na /adresar/(kod='ABRA')/summary vracia 404 s hlásením Can't find record identified by (kod='ABRA').


Odpoveď

Odpoveďou je prehľad súhrnných informácií, rovnaký ako v aplikácii:

{
"winstrom": {
"adresarSummary": {
"celkFakt": "1.2290034529E8",
"limitFakt": "0.0",
"neuzNap": "0.0",
"neuzNav": "24306.55",
"neuzObp": "80952.43",
"neuzObv": "134.31",
"neuzPpp": "0.0",
"neuzPpv": "0.0",
"nezaplaceno": "1.2283741422E8",
"nezaplacenoPoDatSplat": "1.2284548008E8",
"prumProdleva": "-12.75",
"splatText": ""
}
}
}

Vlastnosť

Význam

celkFakt

Celkom fakturované

limitFakt

Limit fakturácie

neuzNap

Neuzavreté ponuky prijaté

neuzNav

Neuzavreté ponuky vydané

neuzObp

Nevyfakturované objednávky prijaté

neuzObv

Neskladované objednávky vydané

neuzPpp

Neuzavreté dopyty prijaté

neuzPpv

Neuzavreté dopyty vydané

nezaplaceno

Nezaplatené

nezaplacenoPoDatSplat

Nezaplatené po splatnosti

prumProdleva

Priemerná omeškanie splácania

splatText

Definovaná splatnosť


Neúspešné požiadavky

Situácia

Odpoveď

Zadaná firma neexistuje

500, formZaznamNenalezen — Záznam nebol v dátovom zdroji nájdený: cz.winstrom.vo.adr.Adresar#1234

ID nie je platný identifikátor — napríklad 123A

404 — Can't find record identified by 123A

Iná HTTP metóda ako GET

405 Method Not Allowed s prázdnou správou


FAQ

Ako vykonať službu „Aktualizovať všetko" a „Aktualizovať z internetu" cez API?

Ako v adresári filtrovať podľa typu vzťahu?

Postup nájdete v článku API adresár - typ vzťahu, filtre.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?