Přeskočit na hlavní obsah

Přepočet skladu - REST API

Jak vyvolat přepočet skladu přes REST API?

Autor: Petr Pech

Přepočet skladu zajišťuje kontrolu a přepočtení skladových stavů a cen za zvolené účetní období. Přes REST API jej lze vyvolat stejně jako v aplikaci.


Způsob volání

Služba je dostupná metodami PUT a POST na adrese /c/{firma}/sklad/prepocet, kde {firma} je databázový identifikátor firmy. Podporovanými výstupními formáty jsou XML a JSON.


Parametry

  • ucetniObdobi — povinný parametr, kterým se identifikuje období, za které chcete sklad přepočítat. Uvádí se jako identifikátor ve tvaru code:2024.

  • dry-run — volitelný parametr, kterým lze zjistit, zda byl přepočet dokončen. Pokud ano, vrátí HTTP status 200. Pokud ne, vrátí HTTP status 409 s informací o tom, kdy a kým byl přepočet spuštěn.


Výsledek

Pro rozpoznání, zda byla služba vykonána úspěšně, lze kontrolovat HTTP status odpovědi nebo vlastnost success v získaném dokumentu.

V případě úspěšného vykonání služby je vracen HTTP status 200 a dokument odpovídající standardnímu formátu, viz návratové hodnoty:

{
"winstrom": {
"@version": "1.0",
"success": "true"
}
}

V případě neúspěchu je vracen status 4xx nebo 5xx a zpráva o důvodu neúspěchu.


Ukázky volání

PUT https://demo.flexibee.eu/c/demo/sklad/prepocet.xml?ucetniObdobi=code:2024
PUT https://demo.flexibee.eu/c/demo/sklad/prepocet.json?ucetniObdobi=code:2024
PUT https://demo.flexibee.eu/c/demo/sklad/prepocet?ucetniObdobi=code:2024

U posledního volání bez přípony se formát určí hlavičkou Accept: application/xml, případně Accept: application/json.


Související

Dostali jste odpověď na svou otázku?