Web API zdroje pro funkce v MS Excelu

V rozhraní Web API je implementováno několik speciálních zdrojů, které je možné využít ke snadnému vytváření nejrůznějších přehledů v celé řadě oblastí - účetnictví, skladové hospodářství, prodej, evidence a odpisy majetku, mzdy a personalistika a další. Přestože jsou primárně navrženy pro potřeby dodávaných funkcí pro MS Excel, dají se používat i samostatně v libovolném prostředí, stejně jako všechny ostatní Web API zdroje.

K využívání všech uvedených zdrojů (turnover, turnover-simple, balance, stock, moves, sale, receivable, payable, depreciation, asset, payroll) je zapotřebí licence na WebAPI doplňky. Licencí je podmíněna dostupnost Web API zdrojů, takže bez ní nebudou fungovat ani Funkce pro MS Excel, které se do těchto zdrojů dotazují.

Výsledky jsou vraceny v podobě prostého textu (odpovědí na každý požadavek je jedna číselná hodnota), nikoli ve standardně podporovaném formátu JSON.

Zdroje slouží k získávání informací o obratech na účtech. Čerpají data z agendy Účetní deník, případně také z agendy Účetní žádosti.

K dispozici jsou dva různé zdroje lišící se způsobem zápisu omezovacích podmínek. Požadavky v obou případech vrací jednu hodnotu - částku obratu v lokální měně za uvedené časové období a další omezení (účty, střediska, zakázky, obchodní případy, projekty, firmy).

Základní varianta - /bookentries/turnover

Příklad požadavku se zadáním: Vrať obrat na účtu 22110 za roky 2005 až 2010, včetně agendy Účetní žádosti, na střediscích 000 a 100 včetně podřízených, ale jen za firmu s kódem 00002:

GET http://localhost:81/demodata/bookentries/turnover?date-from=2005-01-01&date-to=2010-12-31&accounts=22110&include-requests=true&divisions=000,100&divisions-with-children=true&firms=00002

Výsledek zpracování požadavku:

Status: 200 OK 

707562.5
Parametr Povolené hodnoty Výchozí hodnota Popis

date-from

Datum ve formátu rrrr-MM-dd   Počáteční datum intervalu. Povinný parametr.
date-to Datum ve formátu rrrr-MM-dd   Koncové datum intervalu. Povinný parametr.
accounts

Identifikace záznamu z agendy Účtový rozvrh (položka Kód). Je možné zadat více hodnot oddělených čárkou.

  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedené účty.

Povinný parametr.

Samotné kódy účtů je možné doplnit následujícími příznaky (postfixy):

Postfix Význam
+ jen kladné účty (v URL možné zakódovat jako %2B)
- jen záporné účty
MD jen strana MD
D jen strana Dal
> jen kladné hodnoty
< jen záporné hodnoty
include-requests true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Záznamy z agendy Účetní žádosti.
divisions Identifikace záznamu z agendy Střediska (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedená střediska.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na středisko.
divisions-with-children true nebo false false Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na střediska podřízená střediskům uvedeným v parametru divisions.
busorders Identifikace záznamu z agendy Zakázky (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedené zakázky.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na zakázku.
busorders-with-children true nebo false false Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na zakázky podřízené zakázkám uvedeným v parametru busorders.
bustransactions Identifikace záznamu z agendy Obchodní případy (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedené obchodní případy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na obchodní případ.
bustransactions-with-children true nebo false false Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na obchodní případy podřízené obchodním případům uvedeným v parametru bustransactions.
busprojects Identifikace záznamu z agendy Projekty (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedené projekty.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na projekt.
busprojects-with-children true nebo false false Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na projekty podřízené projektům uvedeným v parametru busprojects.
firms Identifikace záznamu z agendy Adresář firem (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedené firmy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na firmu.

 

Zjednodušená varianta - /bookentries/turnover-simple

Příklad požadavku se zadáním: Vrať obrat za roky 2005 až 2010 na straně MD účtů 343xx včetně záznamů z agendy Účetní žádosti, za střediska 000 a 100:

GET http://localhost:81/demodata/bookentries/turnover-simple?date-from=2005-01-01&date-to=2010-12-31&conditions=accounts:343MD$;divisions:000,100

Výsledek zpracování požadavku:

Status: 200 OK 

270797.48
Parametr Popis
date-from Počáteční datum intervalu ve formátu rrrr-MM-dd. Povinný parametr.
date-to Koncové datum intervalu ve formátu rrrr-MM-dd. Povinný parametr.
conditions

Složená výběrová podmínka. Jednotlivé podporované dílčí podmínky accounts, divisions, busorders, bustransactions, busprojects a firms se oddělují středníky.

Místo samostatných podmínek -with-children a include-requests používaných v základní variantě zdroje turnover se používá postfix $.

accounts:34321$ = účet 34321 včetně žádostí

divisions:100$ = středisko 100 včetně podřízených

Seznam ostatních podporovaných postfixů, které je možné používat s parametrem accounts, je shodný jako u základní varianty zdroje turnover.

Povinný parametr.

Zdroj slouží k získávání informací o zůstatcích účtů k určitému datu. Čerpá data z agendy Účetní deník, případně také z agendy Účetní žádosti.

/utils/balance

Příklad požadavku se zadáním: Vrať zůstatek na účtu 02100 ke dni 31.12.2018:

GET http://localhost:81/demodata/utils/balance?date-to=2018-12-31&accounts=02100

Výsledek zpracování požadavku:

Status: 200 OK 

1950000
Parametr Povolené hodnoty Výchozí hodnota Popis
date-to Datum ve formátu rrrr-MM-dd   Datum, ke kterému chceme znát zůstatek účtu (nebo účtů). Povinný parametr.
accounts Identifikace záznamu z agendy Účtový rozvrh (položka Kód). Je možné zadat více hodnot oddělených čárkou.   Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na účty, jejichž kód začíná uvedeným řetězcem.

Pokud zadáte kód 6, zahrnou se účty 60100, 60200, 60400, 61100 atd.

Povinný parametr.

Samotné kódy účtů je možné doplnit příznaky (postfixy). Více viz Zdroj Turnover - parametr accounts.
include-requests true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Záznamy z agendy Účetní žádosti.
divisions Identifikace záznamu z agendy Střediska (položka Kód). Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na uvedená střediska.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na středisko.
divisions-with-children true nebo false false Do výpočtu budou zahrnuty záznamy z agendy Účetní deník (případně také z agendy Účetní žádosti v závislosti na parametru include-requests), pro které platí následující: Jsou navázané na střediska podřízená střediskům uvedeným v parametru divisions.

Zdroj slouží k získávání informací o stavu skladu (počet, cena) k určitému datu podle zvolených kritérií.

/utils/stock

Příklad požadavku se zadáním: Vrať celkový počet kusů ke dni 31.12.2018 na skladech s kódem 01 a 02, ale pouze položky ze skladového menu HW, a se skladovým typem "M" (materiál):

GET http://localhost:81/demodata/utils/stock?date-to=2018-12-31&stores=01,02&store-menu-items=HW&store-card-categories=M&information-type=q

Výsledek zpracování požadavku:

Status: 200 OK 

33
Parametr Povolené hodnoty Výchozí hodnota Popis
date-to Datum ve formátu rrrr-MM-dd   Datum, ke kterému chceme znát stav skladových zásob. Povinný parametr.
stores

Kód skladu. Je možné zadat více hodnot oddělených čárkou.

  

Do výpočtu budou zahrnuty pouze: Stavy na uvedených skladech.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na sklad.
store-menu-items Text skladového menu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Stavy položek z uvedených skladových menu.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové menu.
store-card-categories Kód skladového typu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Stavy položek uvedených skladových typů.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové typy.
store-cards Kód skladové karty. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Stavy uvedených skladových karet.

Pokud se použije tento parametr, ignorují se parametry store-menu-items a store-card-categories.
information-type q nebo a  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Povinný parametr. Možnosti:

  • q = počet (množství, Quantity)
  • a = cena (částka v lokální měně, LocalAmount)

Sčítání množství různých skladových položek nemusí dávat věcný smysl, zejména pokud jsou různé karty evidované v různých jednotkách.

Zdroj slouží k získávání informací o skladových pohybech (počet, cena) za určité období podle zvolených kritérií.

/utils/moves

Příklad požadavku se zadáním: Vrať celkový finanční objem skladových pohybů za rok 2019 na skladech s kódem 01 a 02 pro skladové karty s kódem 01, 02 a 03 na středisku 000:

GET http://localhost:81/demodata/utils/moves?date-from=2019-01-01&date-to=2019-12-31&stores=01,02&store-cards=01,02,03&divisions=000&information-type=a

Výsledek zpracování požadavku:

Status: 200 OK 

30000
Parametr Povolené hodnoty Výchozí hodnota Popis
date-from Datum ve formátu rrrr-MM-dd  

Počáteční datum intervalu.

V případě neuvedení parametru budou zahrnuty: Všechny pohyby od začátku prvního nadefinovaného období až do koncového data intervalu.
date-to Datum ve formátu rrrr-MM-dd   Koncové datum intervalu. Povinný parametr.
stores Kód skladu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby na uvedených skladech.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na sklad.
store-menu-items Text skladového menu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby položek z uvedených skladových menu.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové menu.
store-card-categories Kód skladového typu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby položek uvedených skladových typů.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové typy.
store-cards Kód skladové karty. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby uvedených skladových karet.

Pokud se použije tento parametr, ignorují se parametry store-menu-items a store-card-categories.
divisions Kód střediska. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby navázané na uvedená střediska.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na středisko.
divisions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Pohyby navázané na střediska podřízená střediskům uvedeným v parametru divisions.
busorders Kód zakázky. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby navázané na uvedené zakázky.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na zakázku.
busorders-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Pohyby navázané na zakázky podřízené zakázkám uvedeným v parametru busorders.
bustransactions Kód obchodního případu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby navázané na uvedené obchodní případy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na obchodní případ.
bustransactions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Pohyby navázané na obchodní případy podřízené obchodním případům uvedeným v parametru bustransactions.
busprojects Kód projektu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby navázané na uvedené projekty.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na projekt.
busprojects-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Pohyby navázané na projekty podřízené projektům uvedeným v parametru busprojects.
firms Kód firmy. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohyby navázané na uvedené firmy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na firmu.
information-type q nebo a  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Povinný parametr. Možnosti:

  • q = počet (množství, Quantity)
  • a = cena (částka v lokální měně, LocalAmount)

Sčítání množství různých skladových položek nemusí dávat věcný smysl, zejména pokud jsou různé karty evidované v různých jednotkách.

Zdroj slouží k získávání informací o prodejích skladových položek (počet, prodejní cena bez DPH) za určité období podle zvolených kritérií.

/utils/sale

Příklad požadavku se zadáním: Vrať objem prodejů v lokální měně bez DPH v letech 2005 až 2010 ze skladů 01 a 02, skladové karty 01, 02 a 03, středisko 000:

GET http://localhost:81/demodata/utils/sale?date-from=2005-01-01&date-to=2010-12-31&stores=01,02&store-cards=01,02,03&divisions=000&information-type=a

Výsledek zpracování požadavku:

Status: 200 OK 

933375.16
Parametr Povolené hodnoty Výchozí hodnota Popis
date-from Datum ve formátu rrrr-MM-dd  

Počáteční datum intervalu.

V případě neuvedení parametru budou zahrnuty: Všechny prodeje od začátku prvního nadefinovaného období až do koncového data intervalu.
date-to Datum ve formátu rrrr-MM-dd   Koncové datum intervalu. Povinný parametr.
stores Kód skladu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje z uvedených skladů.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na sklad.
store-menu-items Text skladového menu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje položek z uvedených skladových menu.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové menu.
store-card-categories Kód skladového typu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje položek uvedených skladových typů.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na skladové typy.
store-cards Kód skladové karty. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje uvedených skladových karet.

Pokud se použije tento parametr, ignorují se parametry store-menu-items a store-card-categories.
divisions Kód střediska. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje navázané na uvedená střediska.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na středisko.
divisions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Prodeje navázané na střediska podřízená střediskům uvedeným v parametru divisions.
busorders Kód zakázky. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje navázané na uvedené zakázky.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na zakázku.
busorders-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Prodeje navázané na zakázky podřízené zakázkám uvedeným v parametru busorders.
bustransactions Kód obchodního případu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje navázané na uvedené obchodní případy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na obchodní případ.
bustransactions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Prodeje navázané na obchodní případy podřízené obchodním případům uvedeným v parametru bustransactions.
busprojects Kód projektu. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje navázané na uvedené projekty.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na projekt.
busprojects-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Prodeje navázané na projekty podřízené projektům uvedeným v parametru busprojects.
firms Kód firmy. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Prodeje navázané na uvedené firmy.

V případě neuvedení parametru budou zahrnuty: Všechny záznamy bez ohledu na firmu.
information-type q nebo a  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Povinný parametr. Možnosti:

  • q = počet (množství, Quantity)
  • a = cena (prodejní cena bez DPH, LocalAmount)

Sčítání množství různých skladových položek nemusí dávat věcný smysl, zejména v případě použití různých jednotek.

Zdroj slouží k získávání informací o pohledávkách - vrací částku zvoleného typu vypočítanou podle zvolených kritérií. Používá se obdobně jako zdroj pro závazky.

/utils/receivable

Příklad požadavku se zadáním: Vrať celkovou dosud neuhrazenou částku pohledávek vystavených v roce 2011 pro firmu 00011, v lokální měně:

GET http://localhost:81/demodata/utils/receivable?doc-date-from=2018-01-01&doc-date-to=2018-12-31&firms=00011&information-type=np

Výsledek zpracování požadavku:

Status: 200 OK 

24200
Parametr Povolené hodnoty Výchozí hodnota Popis
doc-date-from Datum ve formátu rrrr-MM-dd  

Nejnižší (počáteční) datum vystavení dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem vystavení od začátku časové osy.
doc-date-to Datum ve formátu rrrr-MM-dd  

Nejvyšší (koncové) datum vystavení dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem vystavení do aktuálního data.
due-date-from Datum ve formátu rrrr-MM-dd  

Nejnižší (počáteční) datum splatnosti dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem splatnosti od začátku časové osy.
due-date-to Datum ve formátu rrrr-MM-dd  

Nejvyšší (koncové) datum splatnosti dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem splatnosti do aktuálního data.
firms Kód firmy. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Pohledávky za specifikovanými firmami.

V případě neuvedení parametru: Bude vrácena celková částka pohledávek za všemi firmami.
currency Kód měny. Je možné zadat pouze jednu hodnotu.  

Měna použitá na zahrnutých dokladech pohledávek.

V případě uvedení parametru: Parametr se použije jako filtr a vrátí se souhrnná částka v měně zadané parametrem (vypočtená z dokladů vystavených v této měně).

V případě neuvedení parametru budou zahrnuty: Všechny pohledávky bez ohledu na měnu vystavení, částky se přepočtou na lokální měnu a vrátí se souhrnná částka v lokální měně (LocalAmount).
information-type t, p, np nebo c  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Pro tento zdroj jediný povinný parametr. Možnosti:

  • t = celkem (Total)
  • p = zaplaceno (Paid)
  • np = nezaplaceno (Not Paid)
  • c = dobropisováno (Credit)

Zdroj slouží k získávání informací o závazcích - vrací částku zvoleného typu vypočítanou podle zvolených kritérií. Používá se obdobně jako zdroj pro pohledávky.

/utils/payable

Příklad požadavku se zadáním: Vrať celkovou částku závazků vůči firmě 00006 z dokladů vystavených v roce 2018, v lokální měně, bez ohledu na stav zaplacení:

GET http://localhost:81/demodata/utils/payable?doc-date-from=2018-01-01&doc-date-to=2018-12-31&firms=00006&information-type=t

Výsledek zpracování požadavku:

Status: 200 OK 

1439244.72
Parametr Povolené hodnoty Výchozí hodnota Popis
doc-date-from Datum ve formátu rrrr-MM-dd  

Nejnižší (počáteční) datum vystavení dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem vystavení od začátku časové osy.
doc-date-to Datum ve formátu rrrr-MM-dd  

Nejvyšší (koncové) datum vystavení dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem vystavení do aktuálního data.
due-date-from Datum ve formátu rrrr-MM-dd  

Nejnižší (počáteční) datum splatnosti dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem splatnosti od začátku časové osy.
due-date-to Datum ve formátu rrrr-MM-dd  

Nejvyšší (koncové) datum splatnosti dokladů, které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny doklady s datem splatnosti do aktuálního data.
firms Kód firmy. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Závazky vůči specifikovaným firmám.

V případě neuvedení parametru: Bude vrácena celková částka závazků vůči všem firmám.
currency Kód měny. Je možné zadat pouze jednu hodnotu.  

Měna použitá na zahrnutých dokladech závazků.

V případě uvedení parametru: Parametr se použije jako filtr a vrátí se souhrnná částka v měně zadané parametrem (vypočtená z dokladů vystavených v této měně).

V případě neuvedení parametru budou zahrnuty: Všechny závazky bez ohledu na měnu vystavení. Částky se přepočtou na lokální měnu a vrátí se souhrnná částka v lokální měně (LocalAmount).
information-type t, p, np nebo c  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Pro tento zdroj jediný povinný parametr. Možnosti:

  • t = celkem (Total)
  • p = zaplaceno (Paid)
  • np = nezaplaceno (Not Paid)
  • c = dobropisováno (Credit)

Zdroj slouží k získávání informací o odpisech - vrací celkovou výši účetních nebo daňových odpisů vypočítanou podle zvolených kritérií.

Pokud při používání Web API zdroje depreciation uvedete parametr date-from (resp. ve funkci GetDepreciation nebo AbraDepreciation v prostředí MS Excelu použijete argument datum dokladu od), zahrnou se do výpočtu pouze odpisy, které jsou zaúčtované.

V opačném případě (pokud datum dokladu od neuvedete) se započítají všechny odpisy bez ohledu na zaúčtování.

Pokud chcete získat hodnotu všech zaúčtovaných odpisů od začátku odepisování, parametr resp. argument specifikující začátek intervalu použijte, ale jako počáteční datum uveďte 1.1.1900 (MS Excel) resp. 1900-01-01 (Web API).

/utils/depreciation

Příklad požadavku se zadáním: Vrať celkovou výši daňových odpisů za rok 2018 za střediska 01 a 02:

GET http://localhost:81/demodata/utils/depreciation?date-from=2018-01-01&date-to=2018-12-31&divisions=01,02&information-type=t

Výsledek zpracování požadavku:

Status: 200 OK 

2162436
Parametr Povolené hodnoty Výchozí hodnota Popis
date-from Datum ve formátu rrrr-MM-dd  

Nejnižší (počáteční) datum vystavení dokladů (odpisů), které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny odpisy s datem vystavení od začátku časové osy.
date-to Datum ve formátu rrrr-MM-dd  

Nejvyšší (koncové) datum vystavení dokladů (odpisů), které chceme do výpočtu zahrnout.

V případě neuvedení parametru budou zahrnuty: Všechny odpisy s datem vystavení do aktuálního data.
asset-types Kód druhu majetku. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy určitých druhů majetku.

V případě neuvedení parametru budou zahrnuty: Všechny druhy.
acc-depreciation-groups Kód účetní odpisové skupiny. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy za určité použité účetní odpisové skupiny.

V případě neuvedení parametru budou zahrnuty: Odpisy bez ohledu na použitou účetní odpisovou skupinu.
tax-depreciation-groups Kód daňové odpisové skupiny. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy za určité použité daňové odpisové skupiny.

V případě neuvedení parametru budou zahrnuty: Odpisy bez ohledu na použitou daňovou odpisovou skupinu.
asset-locations Kód umístění majetku. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy karet majetku s určitým umístěním.

V případě neuvedení parametru budou zahrnuty: Odpisy karet majetku bez ohledu na umístění.

Umístění majetku je položka s historií; při výpočtu se historie zohledňuje.
asset-locations-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: I karty s umístěními podřízenými umístěním uvedeným v parametru asset-locations.
responsibles ID odpovědné osoby. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy karet, ke kterým je přiřazená určitá odpovědná osoba.

V případě neuvedení parametru budou zahrnuty: Odpisy karet bez ohledu na přiřazenou odpovědnou osobu.
divisions Kód střediska. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Odpisy karet přiřazených k určitým evidenčním střediskům.

V případě neuvedení parametru budou zahrnuty: Odpisy karet bez ohledu na přiřazené evidenční středisko.

Evidenční středisko je položka s historií; při výpočtu se historie zohledňuje.
divisions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Karty přiřazené k evidenčním střediskům, která jsou podřízená střediskům uvedeným v parametru divisions.
information-type a nebo t  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Pro tento zdroj jediný povinný parametr. Možnosti:

  • a = účetní odpisy (Account)
  • t = daňové odpisy (Tax)

Zdroj slouží k získávání informací o stavu majetku - vrací vstupní nebo zůstatkovou cenu vypočítanou podle zvolených kritérií.

/utils/asset

Příklad požadavku se zadáním: Vrať daňovou zůstatkovou cenu majetku ke dni 31.12.2018 přiřazeného osobě s ID 4000000101:

GET http://localhost:81/demodata/utils/asset?date-to=2018-12-31&responsibles=4000000101&information-type=tr

Výsledek zpracování požadavku:

Status: 200 OK 

2162436
Parametr Povolené hodnoty Výchozí hodnota Popis
date-to Datum ve formátu rrrr-MM-dd  

Datum, ke kterému cenu majetku zjišťujeme. Povinný parametr.
asset-types Kód druhu majetku. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Určité druhy majetku.

V případě neuvedení parametru budou zahrnuty: Všechny druhy.
acc-depreciation-groups Kód účetní odpisové skupiny. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Karty majetku s určitými účetními odpisovými skupinami.

V případě neuvedení parametru budou zahrnuty: Karty majetku bez ohledu na nastavenou účetní odpisovou skupinu.
tax-depreciation-groups Kód daňové odpisové skupiny. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Karty majetku s určitými daňovými odpisovými skupinami.

V případě neuvedení parametru budou zahrnuty: Karty majetku bez ohledu na nastavenou daňovou odpisovou skupinu.
asset-locations Kód umístění majetku. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Karty majetku s určitým umístěním.

V případě neuvedení parametru budou zahrnuty: Karty majetku bez ohledu na umístění.
asset-locations-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Karty s umístěními podřízenými umístěním uvedeným v parametru asset-locations.
responsibles ID odpovědné osoby. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Karty majetku, ke kterým je přiřazená určitá odpovědná osoba.

V případě neuvedení parametru budou zahrnuty: Karty majetku bez ohledu na přiřazenou odpovědnou osobu.
divisions Kód střediska. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Karty majetku přiřazené k určitým evidenčním střediskům.

V případě neuvedení parametru budou zahrnuty: Karty majetku bez ohledu na přiřazené evidenční středisko.
divisions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Karty majetku přiřazené k evidenčním střediskům, která jsou podřízená střediskům uvedeným v parametru divisions.
information-type ab, tb, ar nebo tr  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Povinný parametr. Jedná se o ceny k datu určenému parametrem date-to. Možnosti:

  • ab = účetní vstupní cena (Account, Base)
  • tb = daňová vstupní cena (Tax, Base)
  • ar = účetní zůstatková cena (Account, Remainder)
  • tr = daňová zůstatková cena (Tax, Remainder)

Zdroj slouží k získávání informací z oblasti mezd a personalistiky - vrací informace různých typů vypočítané podle zvolených kritérií.

/utils/payroll

Příklad požadavku se zadáním: Vrať celkovou odpracovanou dobu v hodinách za mzdové období 2018/12, pouze HPP:

GET http://localhost:81/demodata/utils/payroll?wage-periods=2018/12&employ-patterns=HPP&information-type=t

Výsledek zpracování požadavku:

Status: 200 OK 

960
Parametr Povolené hodnoty Výchozí hodnota Popis
wage-periods Kód mzdového období. Je možné zadat více hodnot oddělených čárkou.  

Kódy mzdových období, za která chceme získat zvolené informace. Povinný parametr.

Do parametru je zapotřebí předávat kódy mzdových období ve stejném tvaru, ve kterém jsou zadány v systému ABRA Gen, tj. např. 2019/03 (nikoli 2019/3 nebo 2019/003). Nejedná se o položku složenou z roku, lomítka a pořadového čísla měsíce, ale o kód období (textový řetězec).
employ-patterns Kód druhu pracovního poměru. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Mzdové listy s pracovními poměry určitého druhu.

V případě neuvedení parametru budou zahrnuty: Mzdové listy se všemi druhy pracovních poměrů.
divisions Kód střediska. Je možné zadat více hodnot oddělených čárkou.  

Do výpočtu budou zahrnuty pouze: Mzdové listy s pracovními poměry založenými na určité středisko.

V případě neuvedení parametru budou zahrnuty: Mzdové listy s pracovními poměry ze všech středisek.
divisions-with-children true nebo false false Parametr určuje, zda do výpočtu zahrnout také: Mzdové listy s pracovními poměry založenými na střediska, která jsou podřízená střediskům uvedeným v parametru divisions.
information-type n, w, f, t nebo g  

Parametr určuje, jaká informace bude ve výsledku zpracování požadavku vrácena. Povinný parametr. Možnosti:

  • n = počet mzdových listů (Number of wage lists)
  • w = úvazky v hodinách celkem (wage calendar Duty)
  • f = fond pracovní doby v hodinách celkem (working Fund)
  • t = počet odpracovaných hodin celkem (Total work time)
  • g = hrubá mzda celkem (Gross wage)