Přeskočit na hlavní obsah

Přepočet stavu účtů - REST API

Jak pomocí API spustit přepočet stavu účtů?

Autor: Petr Pech

Přes REST API lze vyvolat přepočet stavů účtů — tedy stejnou operaci, jakou v aplikaci spouštíte nad účetními výstupy.


Způsob volání

Lze využít HTTP metodu PUT nebo POST. Služba je dostupná na adrese /c/{firma}/stav-uctu/prepocet, kde {firma} je databázový identifikátor firmy. Jsou podporovány výstupní formáty XML nebo JSON.


Parametry

Parametr

Povinnost

Význam

ucetniObdobi

povinný

Období, za které chcete účty přepočítat. Uvádějte kód období po vzoru code:2020.

dry-run

nepovinný

Zjistí, zda byl přepočet dokončen. Pokud ano, vrátí HTTP status 200. Pokud ne, vrátí 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 status 200 a dokument odpovídající standardnímu formátu — viz návratové hodnoty. V případě neúspěchu je vracen status 4xx/5xx a zpráva o důvodu neúspěchu.


Ukázky volání

PUT /c/demo/stav-uctu/prepocet.xml?ucetniObdobi=code:2020
PUT /c/demo/stav-uctu/prepocet.json?ucetniObdobi=code:2020

Formát lze určit i hlavičkou místo přípony — v tom případě přidejte Accept: application/xml nebo Accept: application/json:

PUT /c/demo/stav-uctu/prepocet?ucetniObdobi=code:2020


Související

Dostali jste odpověď na svou otázku?