Přeskočit na hlavní obsah

Účetní výstupy v REST API

Jakým způsobem generovat účetní výstupy v API?

Autor: Petr Pech

Účetní výstupy není nutné generovat pouze přes desktopovou aplikaci či webové rozhraní. Stejně jako ostatní data je můžete získat pomocí REST API ABRA Flexi.

V tomto článku naleznete všechny účetní výstupy, které lze přes REST API vygenerovat, včetně jejich adres a parametrů. Výstupy jsou dostupné jak v PDF, tak v XLSX (u tiskových sestav viz export tiskových sestav), část z nich také v XML, JSON a CSV.


Přehled výstupů

Výstup

Adresa

/c/{firma}/stav-uctu

/c/{firma}/ucetni-denik, /c/{firma}/pohyb-na-uctech

/c/{firma}/hlavni-kniha

/c/{firma}/obratova-predvaha

/c/{firma}/sestava + parametr report-name

/c/{firma}/rozvaha-vykaz.xml

/c/{firma}/vysledovka-po-uctech

/c/{firma}/rozvaha-po-uctech

/c/{firma}/vykaz-hospodareni

/c/{firma}/analyza-zakazky

/c/{firma}/po-splatnosti

/c/{firma}/souhrnne-hlaseni-dph

Kde {firma} je databázový identifikátor firmy. Všechny výstupy se získávají metodou GET a požadovaný formát se volí příponou v adrese.

⚠️ Neznámé parametry server u těchto výstupů tiše ignoruje a vrátí 200 OK — nesprávně pojmenovaný parametr se tedy neprojeví chybou, ale výstupem bez požadovaného omezení. Názvy parametrů proto opisujte přesně podle tabulek níže.


Stavy účtů

Adresa: /c/{firma}/stav-uctu[.xml]. Použít lze i úroveň detailu a filtraci.

Pokud potřebujete stavy za jiné než aktuální účetní období, doplňte do URL parametr ucetniObdobi, jehož hodnotou je zkratka požadovaného účetního období. Druhou možností je parametr idUcetniObdobi, který umožňuje využití identifikátorů účetního období. Pokud je použit, má přednost před parametrem ucetniObdobi.

Stavy účtů lze dělit podle středisek pomocí groupByStredisko=true nebo podle činností pomocí groupByCinnost=true. Každý řádek pak obsahuje stav účtu pro konkrétní středisko nebo činnost.

Příklady použití

URL

Popis

/c/{firma}/stav-uctu

Stavy účtů pro aktuální účetní období

/c/{firma}/stav-uctu?idUcetniObdobi=3

Stavy účtů pro účetní období s ID 3

/c/{firma}/stav-uctu?idUcetniObdobi=code:2016

Stavy účtů pro účetní období se zkratkou 2016

/c/{firma}/stav-uctu?ucetniObdobi=2016

Stavy účtů pro účetní období se zkratkou 2016

/c/{firma}/stav-uctu?groupByStredisko=true

Stavy účtů členěné podle středisek

/c/{firma}/stav-uctu?groupByCinnost=true

Stavy účtů členěné podle činností

/c/{firma}/stav-uctu?groupByStredisko=true&groupByCinnost=true

Stavy účtů členěné podle středisek i činností současně

ℹ️ Podrobněji se stavům účtů věnuje článek Stavy účtů, jejich přepočtu pak Přepočet stavu účtů.


Účetní deník a pohyby na účtech

Adresy: /c/{firma}/ucetni-denik, /c/{firma}/pohyb-na-uctech a /c/{firma}/ucetni-denik-zjednoduseny. Jde o běžné evidence, takže lze použít úrovně detailu, filtraci i stránkování.

Ve všech třech evidencích lze parametrem postingState filtrovat záznamy podle stavu zaúčtování:

Hodnota

Popis

posted

Vrátí pouze zaúčtované doklady (zuctovano = true).

unposted

Vrátí pouze nezaúčtované doklady (zuctovano = false).

all

Vrátí všechny doklady bez ohledu na stav zaúčtování.

Pokud parametr neuvedete, závisí výchozí chování na legislativě firmy: u legislativy DACH (Německo, Rakousko, Švýcarsko) je výchozí hodnotou posted, u ostatních legislativ (např. CZ, SK) all. Hodnota je case-insensitive, takže POSTED, Posted i posted jsou platné.

Příklady volání

GET https://demo.flexibee.eu/c/demo/ucetni-denik.json?postingState=posted
GET https://demo.flexibee.eu/c/demo/ucetni-denik.json?postingState=unposted
GET https://demo.flexibee.eu/c/demo/pohyb-na-uctech.json?postingState=all

Při zadání jiné hodnoty vrátí server 400 s kódem stavZauctovaniNeplatnaHodnota a výčtem povolených hodnot.


Hlavní kniha

Adresa: /c/{firma}/hlavni-kniha.{přípona}. Podporovanými formáty jsou pdf, xlsx, xml, json a csv.

Parametry

  • ucetniObdobi — kód účetního období ve tvaru s code: (např. code:2024)

  • koncovyMesicRok — hlavní kniha do zadaného měsíce ve formátu MM/yyyy (např. 06/2024)

  • pocetMesicu — počet měsíců v hlavní knize

  • stredisko — kód objektu z evidence /stredisko, lze uvést vícekrát (např. stredisko=code:C&stredisko=code:B)

  • mena — kód měny, lze uvést vícekrát (např. mena=code:CZK&mena=code:EUR)

  • filtrUcty — kódy účtů, případně jejich prefix nebo rozsah, oddělené čárkou (např. 311000,32,3-4)

  • ucet — kód účtu, lze uvést vícekrát (např. ucet=code:211001&ucet=code:112001)

Pokud nejsou parametry uvedeny, vrátí se hlavní kniha za aktuální účetní období. Výsledné období lze zvolit buď parametrem ucetniObdobi, nebo kombinací parametrů koncovyMesicRok a pocetMesicu.

GET https://demo.flexibee.eu/c/demo/hlavni-kniha.pdf?ucetniObdobi=code:2024
GET https://demo.flexibee.eu/c/demo/hlavni-kniha.pdf?koncovyMesicRok=12/2024&pocetMesicu=12
GET https://demo.flexibee.eu/c/demo/hlavni-kniha.json?ucetniObdobi=code:2024&filtrUcty=311


Obratová předvaha

Adresa: /c/{firma}/obratova-predvaha.{přípona}, typicky pdf nebo xlsx. Parametry ucetniObdobi, koncovyMesicRok, pocetMesicu, stredisko, mena, filtrUcty a ucet se chovají stejně jako u hlavní knihy.

Navíc lze parametrem report-name zvolit podobu sestavy:

  • Predvaha — Obratová předvaha

  • PredvahaPort — Obratová předvaha (na výšku)

Pokud parametry neuvedete, vygeneruje se Obratová předvaha (na výšku) za aktuální účetní období.

GET https://demo.flexibee.eu/c/demo/obratova-predvaha.pdf?report-name=Predvaha&ucetniObdobi=code:2024&koncovyMesicRok=06/2024&pocetMesicu=12&stredisko=code:C&mena=code:CZK&filtrUcty=3&ucet=code:211001

⚠️ U obratové předvahy i hlavní knihy vyžaduje parametr ucetniObdobi tvar s prefixem code:. Hodnota bez prefixu (např. ucetniObdobi=2024) skončí chybou 404. U výkazu hospodaření je to naopak — viz Výkaz hospodaření.


Rozvaha

Adresa: /c/{firma}/sestava.{přípona}. Povinný parametr report-name určuje požadovanou tiskovou sestavu:

  • rozvaha$$SUM_ZAKL — Rozvaha v základním rozsahu

  • rozvaha$$SUM — Rozvaha ve zjednodušeném rozsahu

  • rozvaha$$NES — Rozvaha v plném rozsahu

GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=rozvaha$$SUM_ZAKL
GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=rozvaha$$SUM
GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=rozvaha$$NES

Ve všech případech je odpovědí 200 OK a požadovaný dokument.

ℹ️ Bez parametru report-name vrátí adresa /c/{firma}/sestava.pdf přehled definic účetních sestav, nikoli konkrétní výkaz. Přepočtu a struktuře sestav se věnuje článek Účetní sestavy v API.


Výkaz zisku a ztráty

Adresa: /c/{firma}/sestava.{přípona}, hodnoty parametru report-name:

  • vysledovka$$SUM — Výkaz zisku a ztráty ve zjednodušeném rozsahu

  • vysledovka$$NES — Výkaz zisku a ztráty v plném rozsahu

GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=vysledovka$$SUM
GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=vysledovka$$NES


Přehled o peněžních tocích

Adresa: /c/{firma}/sestava.{přípona}, hodnoty parametru report-name:

  • cashFlow$$NES — Přehled o peněžních tocích

  • cashFlow$$MIN_OBDOBI — Přehled o peněžních tocích včetně údajů za minulé období

GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=cashFlow$$NES
GET https://demo.flexibee.eu/c/demo/sestava.pdf?report-name=cashFlow$$MIN_OBDOBI


Rozvaha a výkaz zisku a ztráty v XML

Adresa: /c/{firma}/rozvaha-vykaz.xml. Výstupem je XML písemnosti pro finanční správu. Služba vyžaduje tři povinné parametry — druh, rozsah a typ (účetní jednotky):

Parametr

Hodnoty

druh

B — řádné, O — řádné opravné, D — dodatečné, E — dodatečné opravné

rozsah

P — plný, Z — zjednodušený

typ

M — mikro, L — malá, S — střední, V — velká

Chyba při nevypočtené sestavě

GET https://demo.flexibee.eu/c/demo/rozvaha-vykaz.xml?druh=B&rozsah=P&typ=M

Odpovědí je 400 Bad Request s kódem priznaniDanPoNeniVypocet:

<?xml version="1.0" ?>
<winstrom version="1.0">
<success>false</success>
<message>Pro vygenerování Rozvaha a výkaz zisku a ztráty v XML musí být vypočtené sestavy Rozvaha v plném rozsahu a Výkaz zisku a ztráty - druhové členění.</message>
</winstrom>

Úspěšné volání

Po přepočtení potřebných sestav vrátí stejné volání 200 OK a XML v této struktuře (hodnoty jsou ilustrativní):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Pisemnost nazevSW="ABRA Flexi" verzeSW="2026.5.2">
<DPPDP8 verzePis="05.01.01">
<VetaD c_nace="582000" c_ufo_cil="451" dapdpp_forma="B" dokument="DP8" k_uladis="DPP" kat_uj="M" typ_dapdpp="A" typ_popldpp="1" typ_zo="A" uv_vyhl="500" zdobd_do="31.12.2024" zdobd_od="01.01.2024"/>
<VetaP c_pop="1" c_pracufo="2005" dic="CZ12345678" naz_obce="Praha" opr_jmeno="Jan" opr_postaveni="Jednatel" opr_prijmeni="Vzorový" psc="10000" ulice="Ulice 1" zkrobchjm="Vzorová firma s.r.o."/>
<VetaO/>
<VetaUA c_radku="1" kc_brutto="0" kc_korekce="0" kc_netto="0" kc_netto_min="0"/>
<VetaUB c_radku="1" kc_min="13817245.31" kc_sled="3788007.63"/>
<VetaUD c_radku="66" kc_min="0" kc_sled="0"/>
</DPPDP8>
</Pisemnost>


Soupis nákladů a výnosů

Adresa: /c/{firma}/vysledovka-po-uctech.{přípona}.

Parametry

  • report-name — kód tiskové sestavy (např. vysledovkaPoUctechStavy)

  • ucetniObdobi — kód účetního období (např. 2024), výchozí je aktuální účetní období

  • filtrUcty — kódy účtů, případně jejich prefix nebo rozsah, oddělené čárkou (např. 311000,32,3-4)

  • ucet — kód účtu, lze uvést vícekrát (např. ucet=code:211001&ucet=code:112001)

  • danoveUcty — pokud není uveden, jsou zahrnuty daňové i nedaňové účty

  • stredisko — kód objektu z evidence /stredisko, lze uvést vícekrát

  • cinnost — kód objektu z evidence /cinnost, lze uvést vícekrát

  • mena — kód měny, lze uvést vícekrát

  • groupByStrediskotrue / false, aktivuje či deaktivuje členění dle středisek

  • groupByCinnosttrue / false, aktivuje či deaktivuje členění dle činností

GET https://demo.flexibee.eu/c/demo/vysledovka-po-uctech.pdf?report-name=vysledovkaPoUctechStavy&ucetniObdobi=2024&mena=code:CZK&danoveUcty=true&stredisko=code:C

⚠️ Pokud firma nemá odpovídající tiskovou sestavu k dispozici, vrátí služba 406 s kódem neexistujeReport. Chybí pak definice sestavy, nikoli parametr volání.


Soupis aktiv a pasiv

Adresa: /c/{firma}/rozvaha-po-uctech.{přípona}. Parametry jsou shodné se soupisem nákladů a výnosů, pouze bez parametru danoveUcty.

GET https://demo.flexibee.eu/c/demo/rozvaha-po-uctech.pdf?report-name=rozvahaPoUctechObraty&mena=code:CZK&filtrUcty=2,32,022001&ucet=code:082001&stredisko=code:C


Výkaz hospodaření

Adresa: /c/{firma}/vykaz-hospodareni.{přípona}.

Parametry

  • report-name — povinná hodnota vykazHospodareni

  • mesicRok — povinný měsíc a rok ve formátu MM/yyyy (např. 04/2024)

  • ucetniObdobi — kód účetního období bez prefixu code: (např. 2024), výchozí je aktuální účetní období

  • filtrUcty, ucet, stredisko, cinnost, mena — stejný význam jako u soupisu nákladů a výnosů

GET https://demo.flexibee.eu/c/demo/vykaz-hospodareni.pdf?report-name=vykazHospodareni&ucetniObdobi=2024&mesicRok=04/2024&mena=code:CZK

⚠️ Měsíc v parametru mesicRok musí spadat do zvoleného účetního období. Pokud se s ním neshoduje, vrátí služba 400 s hlášením, že hodnoty parametrů mesicRok a ucetniObdobi nejsou vzájemně slučitelné. Bez parametru report-name skončí volání chybou 406.


Účetní analýza zakázky

Adresa: /c/{firma}/analyza-zakazky.{přípona}. Povinné jsou pouze parametry období.

Parametry

  • uctovaniOd — povinné počáteční datum účtování ve formátu yyyy-MM-dd (např. 2024-01-01)

  • uctovaniDo — povinné koncové datum účtování ve formátu yyyy-MM-dd (např. 2024-12-31)

  • report-name — pokud není uveden, použije se analyzaZakazky

  • zakazka — kód objektu z evidence /zakazka, lze uvést vícekrát (např. zakazka=code:ZAK1&zakazka=code:ZAK2)

  • stredisko — kód objektu z evidence /stredisko, lze uvést vícekrát (např. stredisko=code:C&stredisko=code:B)

  • cinnost — kód objektu z evidence /cinnost, lze uvést vícekrát (např. cinnost=code:1&cinnost=code:2)

GET https://demo.flexibee.eu/c/demo/analyza-zakazky.pdf?uctovaniOd=2024-01-01&uctovaniDo=2024-12-31&zakazka=code:ZAK1&zakazka=code:ZAK2

Chybějící parametr období skončí chybou 400 s kódem missing_param_exception, neexistující zakázka, středisko či činnost chybou 404.


Neuhrazené pohledávky a závazky po splatnosti

Adresa: /c/{firma}/po-splatnosti.{přípona}.

Parametry

  • datumVypoctu — povinné datum výpočtu reportu ve formátu yyyy-MM-dd (např. 2024-09-01)

  • report-name — pokud není uveden, použije se poSplatnosti; k dispozici je i poSplatnostiDleDokladu

  • modul — kód účetního modulu, lze uvést vícekrát (např. modul=FAV&modul=PHL). Platné hodnoty jsou FAP, FAV, PHL a ZAV.

  • rozmezi1rozmezi6 — rozmezí splatností ve dnech, výchozí hodnoty jsou 30, 60, 90, 180, 360 a 720

GET https://demo.flexibee.eu/c/demo/po-splatnosti.pdf?report-name=poSplatnostiDleDokladu&datumVypoctu=2024-09-01&rozmezi1=0&modul=FAP&modul=PHL

⚠️ Pokud parametry rozmezi1rozmezi6 uvedete, musí být každá hodnota stejná nebo vyšší než hodnota předchozí. Jinak volání skončí chybou 400. Neplatný kód modulu vrátí 404.


Souhrnné hlášení k DPH

Adresa: /c/{firma}/souhrnne-hlaseni-dph.{přípona}.

Parametry

  • rok — rok přiznání (např. 2024), vždy povinný

  • ctvrtleti — pro čtvrtletní podání, hodnoty 14

  • mesic — pro měsíční podání, hodnoty 112

  • stat — stát, pro který se má hlášení zpracovat. Hodnoty CZ a SK; pokud není uveden, použije se stát legislativy firmy.

Vždy je nutné zadat dvojici parametrů období — buď rok a ctvrtleti, nebo rok a mesic. Samotný rok skončí chybou 400 s kódem missing_param_exception.

GET https://demo.flexibee.eu/c/demo/souhrnne-hlaseni-dph.pdf?rok=2024&mesic=2&stat=CZ

ℹ️ Souhrnnému hlášení včetně výstupu v XML pro finanční správu se podrobně věnuje článek Souhrnné hlášení k DPH - REST API.


Související

Dostali jste odpověď na svou otázku?