Všechny sbírky
Dokumentace REST API
Pokročilé příkazy
Souhrnné informace o firmě v adresáři přes REST API
Souhrnné informace o firmě v adresáři přes REST API

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

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než týdnem

V aplikaci jsou dostupné souhrnné informace na vybraném adresářovém záznamu pod záložkou "Souhrnné informace".

Přehled obsahuje informace jako celková fakturované částka, nezaplacená částka, splatnost apod. Tyto informace jsou dostupné i v REST API.

Příklady použití

Request zasíláme metodou GET na URL:
GET https://demo.flexibee.eu/c/demo/adresar/{id}/summary.xml (.json)

kde {id} je identifikátor dané firmy v seznamu obchodních partnerů. Aktuálně není možné využít jiné identifikátor filtrace než {id}.

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

Odpověď ABRA Flexi je pak přehled souhrnných informací 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": ""
}
}
}

Neúspěšné requesty

1. zadaný/filtrovaný objekt (firma) neexistuje
V případě, že se objekt nepodaří nalézt/neexistuje, je odpověď API:

{
"winstrom": {
"@version": "1.0",
"success": "false",
"message": "Záznam nebyl v datovém zdroji nalezen: cz.winstrom.vo.adr.Adresar#1234"
}
}

2. ID je špatně zadáno (ID je pouze číslo - databázový identifikátor)

V případě, že je zadáno nevalidní ID

Can't find record identified by 123A

3. Použitá špatná HTTP metoda, jiná než GET

Pro volání je nutné vždy použít HTTP metodu GET

405 Method not allowed
{
"winstrom": {
"@version": "1.0",
"success": "false"
}
}

FAQ


Potřebujete poradit?

V případě dotazů k aplikaci nás kontaktujte na podporaflexi@abra.eu případně prostřednictvím chat okna v pravém dolním rohu.

Dostali jste odpověď na svou otázku?