Preskoči na glavno vsebino

Účtovné výstupy v REST API

Akým spôsobom generovať účtovné výstupy v API?

Avtor: Petr Pech

Účtovné výstupy nie je nutné generovať iba prostredníctvom desktopovej aplikácie či webového rozhrania. Rovnako ako ostatné dáta ich môžete získať pomocou REST API ABRA Flexi.

V tomto článku nájdete všetky účtovné výstupy, ktoré je možné cez REST API vygenerovať, vrátane ich adries a parametrov. Výstupy sú dostupné tak v PDF, ako aj v XLSX (pri tlačových zostavách pozri export tlačových zostáv), časť z nich aj v XML, JSON a CSV.

Prehľad výstupov

Výstup

Adresa

Stavy účtov

/c/{firma}/stav-uctu

Účtovný denník a pohyby na účtoch

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

Hlavná kniha

/c/{firma}/hlavni-kniha

Obratová predvaha

/c/{firma}/obratova-predvaha

Súvaha, Výkaz ziskov a strát, Prehľad o peňažných tokoch

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

Súvaha a výkaz ziskov a strát v XML

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

Súpis nákladov a výnosov

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

Súpis aktív a pasív

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

Výkaz hospodárenia

/c/{firma}/vykaz-hospodareni

Účtovná analýza zákazky

/c/{firma}/analyza-zakazky

Neuhradené pohľadávky a záväzky po splatnosti

/c/{firma}/po-splatnosti

Súhrnný výkaz k DPH

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

Kde {firma} je databázový identifikátor firmy. Všetky výstupy sa získavajú metódou GET a požadovaný formát sa volí príponou v adrese.

⚠️ Neznáme parametre server pri týchto výstupoch ticho ignoruje a vráti 200 OK — nesprávne pomenovaný parameter sa teda neprejaví chybou, ale výstupom bez požadovaného obmedzenia. Názvy parametrov preto opisujte presne podľa tabuliek nižšie.

Stavy účtov

Adresa: /c/{firma}/stav-uctu[.xml]. Použiť je možné aj úroveň detailu a filtrovanie.

Ak potrebujete stavy za iné než aktuálne účtovné obdobie, doplňte do URL parameter ucetniObdobi, ktorého hodnotou je skratka požadovaného účtovného obdobia. Druhou možnosťou je parameter idUcetniObdobi, ktorý umožňuje využitie identifikátorov účtovného obdobia. Ak je použitý, má prednosť pred parametrom ucetniObdobi.

Stavy účtov je možné deliť podľa stredísk pomocou groupByStredisko=true alebo podľa činností pomocou groupByCinnost=true. Každý riadok potom obsahuje stav účtu pre konkrétne stredisko alebo činnosť.

Príklady použitia

URL

Popis

/c/{firma}/stav-uctu

Stavy účtov pre aktuálne účtovné obdobie

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

Stavy účtov pre účtovné obdobie s ID 3

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

Stavy účtov pre účtovné obdobie so skratkou 2016

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

Stavy účtov pre účtovné obdobie so skratkou 2016

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

Stavy účtov členené podľa stredísk

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

Stavy účtov členené podľa činností

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

Stavy účtov členené podľa stredísk aj činností súčasne

ℹ️ Podrobnejšie sa stavom účtov venuje článok Stavy účtov, ich prepočtu potom Prepočet stavu účtov.

Účtovný denník a pohyby na účtoch

Adresy: /c/{firma}/ucetni-denik, /c/{firma}/pohyb-na-uctech a /c/{firma}/ucetni-denik-zjednoduseny. Ide o bežné evidencie, takže je možné použiť úrovne detailu, filtrovanie aj stránkovanie.

Vo všetkých troch evidenciách je možné parametrom postingState filtrovať záznamy podľa stavu zaúčtovania:

Hodnota

Popis

posted

Vráti iba zaúčtované doklady (zuctovano = true).

unposted

Vráti iba nezaúčtované doklady (zuctovano = false).

all

Vráti všetky doklady bez ohľadu na stav zaúčtovania.

Ak parameter neuvediete, výchozie správanie závisí od legislatívy firmy: pri legislatíve DACH (Nemecko, Rakúsko, Švajčiarsko) je predvolenou hodnotou posted, pri ostatných legislatívach (napr. CZ, SK) all. Hodnota je case-insensitive, takže POSTED, Posted aj posted sú platné.

Príklady volania

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

Pri zadaní inej hodnoty vráti server 400 s kódom stavZauctovaniNeplatnaHodnota a výpočtom povolených hodnôt.

Hlavná kniha

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

Parametre

  • ucetniObdobi — kód účtovného obdobia v tvare s code: (napr. code:2024)

  • koncovyMesicRok — hlavná kniha do zadaného mesiaca vo formáte MM/yyyy (napr. 06/2024)

  • pocetMesicu — počet mesiacov v hlavnej knihe

  • stredisko — kód objektu z evidencie /stredisko, je možné uviesť viackrát (napr. stredisko=code:C&stredisko=code:B)

  • mena — kód meny, je možné uviesť viackrát (napr. mena=code:CZK&mena=code:EUR)

  • filtrUcty — kódy účtov, prípadne ich prefix alebo rozsah, oddelené čiarkou (napr. 311000,32,3-4)

  • ucet — kód účtu, je možné uviesť viackrát (napr. ucet=code:211001&ucet=code:112001)

Ak nie sú parametre uvedené, vráti sa hlavná kniha za aktuálne účtovné obdobie. Výsledné obdobie je možné zvoliť buď parametrom ucetniObdobi, alebo kombináciou parametrov 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á predvaha

Adresa: /c/{firma}/obratova-predvaha.{přípona}, typicky pdf alebo xlsx. Parametre ucetniObdobi, koncovyMesicRok, pocetMesicu, stredisko, mena, filtrUcty a ucet sa správajú rovnako ako pri hlavnej knihe.

Naviac je možné parametrom report-name zvoliť podobu zostavy:

  • Predvaha — Obratová predvaha

  • PredvahaPort — Obratová predvaha (na výšku)

Ak parametre neuvediete, vygeneruje sa Obratová predvaha (na výšku) za aktuálne účtovné obdobie.

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

⚠️ Pri obratovej predvahe aj hlavnej knihe vyžaduje parameter ucetniObdobi tvar s prefixom code:. Hodnota bez prefixu (napr. ucetniObdobi=2024) skončí chybou 404. Pri výkaze hospodárenia je to naopak — pozri Výkaz hospodárenia.

Súvaha

Adresa: /c/{firma}/sestava.{přípona}. Povinný parameter report-name určuje požadovanú tlačovú zostavu:

  • rozvaha$$SUM_ZAKL — Súvaha v základnom rozsahu

  • rozvaha$$SUM — Súvaha v zjednodušenom rozsahu

  • rozvaha$$NES — Súvaha v plnom 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

Vo všetkých prípadoch je odpoveďou 200 OK a požadovaný dokument.

ℹ️ Bez parametra report-name vráti adresa /c/{firma}/sestava.pdf prehľad definícií účtovných zostáv, nie konkrétny výkaz. Prepočtu a štruktúre zostáv sa venuje článok Účtovné zostavy v API.

Výkaz ziskov a strát

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

  • vysledovka$$SUM — Výkaz ziskov a strát v zjednodušenom rozsahu

  • vysledovka$$NES — Výkaz ziskov a strát v plnom 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

Prehľad o peňažných tokoch

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

  • cashFlow$$NES — Prehľad o peňažných tokoch

  • cashFlow$$MIN_OBDOBI — Prehľad o peňažných tokoch vrátane údajov za minulé obdobie

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

Súvaha a výkaz ziskov a strát v XML

Adresa: /c/{firma}/rozvaha-vykaz.xml. Výstupom je XML písomnosti pre finančnú správu. Služba vyžaduje tri povinné parametre — druh, rozsah a typ (účtovné jednotky):

Parameter

Hodnoty

druh

B — riadne, O — riadne opravné, D — dodatočné, E — dodatočné opravné

rozsah

P — plný, Z — zjednodušený

typ

M — mikro, L — malá, S — stredná, V — veľká

Chyba pri nevypočítanej zostave

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

Odpoveďou je 400 Bad Request s kódom 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>

Úspešné volanie

Po prepočítaní potrebných zostáv vráti rovnaké volanie 200 OK a XML v tejto štruktúre (hodnoty sú ilustratívne):

<?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>

Súpis nákladov a výnosov

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

Parametre

  • report-name — kód tlačovej zostavy (napr. vysledovkaPoUctechStavy)

  • ucetniObdobi — kód účtovného obdobia (napr. 2024), predvolené je aktuálne účtovné obdobie

  • filtrUcty — kódy účtov, prípadne ich prefix alebo rozsah, oddelené čiarkou (napr. 311000,32,3-4)

  • ucet — kód účtu, je možné uviesť viackrát (napr. ucet=code:211001&ucet=code:112001)

  • danoveUcty — ak nie je uvedený, sú zahrnuté daňové aj nedaňové účty

  • stredisko — kód objektu z evidencie /stredisko, je možné uviesť viackrát

  • cinnost — kód objektu z evidencie /cinnost, je možné uviesť viackrát

  • mena — kód meny, je možné uviesť viackrát

  • groupByStredisko — true / false, aktivuje alebo deaktivuje členenie podľa stredísk

  • groupByCinnost — true / false, aktivuje alebo deaktivuje členenie podľa č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

⚠️ Ak firma nemá zodpovedajúcu tlačovú zostavu k dispozícii, vráti služba 406 s kódom neexistujeReport. Chýba potom definícia zostavy, nie parameter volania.

Súpis aktív a pasív

Adresa: /c/{firma}/rozvaha-po-uctech.{přípona}. Parametre sú zhodné so súpisom nákladov a výnosov, iba bez parametra 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 hospodárenia

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

Parametre

  • report-name — povinná hodnota vykazHospodareni

  • mesicRok — povinný mesiac a rok vo formáte MM/yyyy (napr. 04/2024)

  • ucetniObdobi — kód účtovného obdobia bez prefixu code: (napr. 2024), predvolené je aktuálne účtovné obdobie

  • filtrUcty, ucet, stredisko, cinnost, mena — rovnaký význam ako pri súpise nákladov a výnosov

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

⚠️ Mesiac v parametri mesicRok musí spadať do zvoleného účtovného obdobia. Ak sa s ním nezhoduje, vráti služba 400 s hlásením, že hodnoty parametrov mesicRok a ucetniObdobi nie sú vzájomne zlučiteľné. Bez parametra report-name skončí volanie chybou 406.

Účtovná analýza zákazky

Adresa: /c/{firma}/analyza-zakazky.{přípona}. Povinné sú iba parametre obdobia.

Parametre

  • uctovaniOd — povinný počiatočný dátum účtovania vo formáte yyyy-MM-dd (napr. 2024-01-01)

  • uctovaniDo — povinný koncový dátum účtovania vo formáte yyyy-MM-dd (napr. 2024-12-31)

  • report-name — ak nie je uvedený, použije sa analyzaZakazky

  • zakazka — kód objektu z evidencie /zakazka, je možné uviesť viackrát (napr. zakazka=code:ZAK1&zakazka=code:ZAK2)

  • stredisko — kód objektu z evidencie /stredisko, je možné uviesť viackrát (napr. stredisko=code:C&stredisko=code:B)

  • cinnost — kód objektu z evidencie /cinnost, je možné uviesť viackrát (napr. 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

Chýbajúci parameter obdobia skončí chybou 400 s kódom missing_param_exception, neexistujúca zákazka, stredisko či činnosť chybou 404.

Neuhradené pohľadávky a záväzky po splatnosti

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

Parametre

  • datumVypoctu — povinný dátum výpočtu reportu vo formáte yyyy-MM-dd (napr. 2024-09-01)

  • report-name — ak nie je uvedený, použije sa poSplatnosti; k dispozícii je aj poSplatnostiDleDokladu

  • modul — kód účtovného modulu, je možné uviesť viackrát (napr. modul=FAV&modul=PHL). Platné hodnoty sú FAP, FAV, PHL a ZAV.

  • rozmezi1 až rozmezi6 — rozsah splatností v dňoch, predvolené hodnoty sú 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

⚠️ Ak parametre rozmezi1 až rozmezi6 uvediete, musí byť každá hodnota rovnaká alebo vyššia než hodnota predchádzajúca. Inak volanie skončí chybou 400. Neplatný kód modulu vráti 404.

Súhrnný výkaz k DPH

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

Parametre

  • rok — rok priznania (napr. 2024), vždy povinný

  • ctvrtleti — pre štvrťročné podanie, hodnoty 1 až 4

  • mesic — pre mesačné podanie, hodnoty 1 až 12

  • stat — štát, pre ktorý sa má výkaz spracovať. Hodnoty CZ a SK; ak nie je uvedený, použije sa štát legislatívy firmy.

Vždy je nutné zadať dvojicu parametrov obdobia — buď rok a ctvrtleti, alebo rok a mesic. Samotný rok skončí chybou 400 s kódom missing_param_exception.

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

ℹ️ Súhrnnému výkazu vrátane výstupu v XML pre finančnú správu sa podrobne venuje článok Súhrnný výkaz k DPH - REST API.

Súvisiace

Sorodni članki
Ste s tem dobili odgovor na svoje vprašanje?