Přeskočit na hlavní obsah

Souhrnné informace o firmě v adresáři přes REST API

Jak získat informace o obchodním partnerovi pomocí REST API Flexi

Autor: Petr Pech

V aplikaci jsou na vybraném adresářovém záznamu dostupné souhrnné informace pod záložkou Souhrnné informace — celková fakturovaná částka, nezaplacená částka, splatnost a podobně. Tatáž statistika finanční bilance s obchodním partnerem je dostupná i v REST API.


Sestavení URL

Požadavek se zasílá metodou GET na subevidenci summary konkrétního záznamu z adresáře:

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

⚠️ Firmu lze adresovat číselným ID nebo identifikátorem code:ZKRATKA. Filtrace v kulatých závorkách zde nefunguje — dotaz na /adresar/(kod='ABRA')/summary vrací 404 s hlášením Can't find record identified by (kod='ABRA').


Odpověď

Odpovědí je přehled souhrnných informací, stejný jako v aplikaci:

{
"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": ""
}
}
}

Vlastnost

Význam

celkFakt

Celkem fakturováno

limitFakt

Limit fakturace

neuzNap

Neuzavřené nabídky přijaté

neuzNav

Neuzavřené nabídky vydané

neuzObp

Nevyfakturované objednávky přijaté

neuzObv

Nenaskladněné objednávky vydané

neuzPpp

Neuzavřené poptávky přijaté

neuzPpv

Neuzavřené poptávky vydané

nezaplaceno

Nezaplaceno

nezaplacenoPoDatSplat

Nezaplaceno po splatnosti

prumProdleva

Průměrná prodleva splácení

splatText

Definovaná splatnost


Neúspěšné požadavky

Situace

Odpověď

Zadaná firma neexistuje

500, formZaznamNenalezenZáznam nebyl v datovém zdroji nalezen: cz.winstrom.vo.adr.Adresar#1234

ID není platný identifikátor — například 123A

404Can't find record identified by 123A

Jiná HTTP metoda než GET

405 Method Not Allowed s prázdnou zprávou


FAQ

Jak provést službu „Aktualizovat vše" a „Aktualizovat z internetu" přes API?

Jak v adresáři filtrovat podle typu vztahu?

Postup najdete v článku API adresář - typ vztahu, filtry.


Související

Dostali jste odpověď na svou otázku?