Přeskočit na hlavní obsah
Všechny sbírkyDokumentace REST APIPokročilé příkazy
Přiznání DPH - REST API
Přiznání DPH - REST API

Jak přes API získat přiznání DPH v XML nebo PDF?

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než 8 měsíci

Stejně jako v aplikaci, lze přiznání DPH je možné získat v XML/PDF i prostřednictví API Flexi.

Způsob volání

Lze využít HTTP metodu: POST

Přiznání DPH je dostupné na adrese:

https://demo.flexibee.eu/c/{firma}/priznani-dph.pdf/xml ,kde {firma} je databázový idenfitikátor firmy.

Jsou podporovány výstupní formáty: XML nebo PDF.

Parametry

Pro generování výstupu jsou dostupné parametry, které uvedeme do těla požadavku:

  • koeficient - nepovinný parametr, koeficient pro výpočet poměrné části odpočtu daně (§ 76). Výchozí hodnoty: Česko 100, Slovensko 0

  • rok - povinný parametr, uveďte rok, ze který přiznání generujete (např. 2020, 2021 apod.)

  • mesic - povinny parametr v případě měsíční periody, uveďte počáteční měsíc, od kterého se přiznání generuje (např. 1, 3 apod.)

  • ctvrtleti - povinny parametr v případě čtvrtletní periody, uveďte kvartál, za který přiznání generujete - Q1, Q2, Q3 nebo Q4

    druh - nepovinný parametr, určuje druh přiznání k DPH, možnosti, které nabývá (implicitně nebývá hodnoty radne):

    • Česko: radne, radneOpravne, dodatecne, dodatecneOpravne

    • Slovensko: radne, opravne, dodatecne

  • vyporadaciKoeficient - nepovinný parametr, tento koeficient není přepočítávám programem, proto je třeba si ho vypočítat a zadat ručně

  • kodZdanObd - nepovinný String Kód zdanitelného období

  • zmenaOdpoctu - nepovinný parametr, změnou odpočtu se rozumí rozdíl mezi vypočteným odpočtem a uplatněným odpočtem. (ř. 53)

  • dodatecneOproti - povinný parametr v případě dodatečných přiznání, jedná se o odkaz na řádky přiznání DPH, kde jsou uložena předchozí přiznání, odkaz je pomocí ID předchozího přiznání.

/radek-priznani-dph/((rok eq "2021") and ((mesic eq "8") and ((clenDph is null) and (typSzbDphK is null))))

  • datumZjisteni - nepovinný parametr v případě dodatečných přiznání, datum zjištění změn ve formát YYYY-MM-DD

  • danKUhrade - nepovinný parametr, celé číslo, daň k úhradě pro řádek 38. Jen pro druh přiznání dodatecne

  • ulozit - nepovinný, nabývá true/false , zda se má vygenerované přiznání uložit do databáze, výchozí false

  • report-name - nepovinný parametr, název reportu (pouze pro formát PDF)

Ukázka volání

1. Řádné přiznání k DPH v PDF za leden 2023:

GET

https://demo.flexibee.eu/c/demo/priznani-dph.pdf?koeficient=100&rok=2023&mesic=1

Výstup:

PDF soubor Přiznání

2. Slovenské dodatečné přiznání k DPH v XML za leden 2023:

GET

https://demo.flexibee.eu/c/demo/priznani-dph.xml?koeficient=0&rok=2023&mesic=1&druh=dodatecne&dodatecneOproti=15&datumZjisteni=2023-06-13

Výstup:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Pisemnost nazevSW="ABRA Flexi" verzeSW="SNAPSHOT">
    <DPHDP3 verzePis="02.01.03">
        <VetaD c_okec="" d_poddp="01.12.2023" d_zjist="13.06.2023" dapdph_forma="D" dokument="DP3" k_uladis="DPH" mesic="3" rok="2015" trans="A" typ_platce="P"/>
        <VetaP c_pop="277" c_pracufo="3104" c_ufo="462" dic="02230607" email="info@abra.eu" naz_obce="Praha" opr_postaveni="jednatelka" psc="10100" stat="ČESKÁ REPUBLIKA" typ_ds="P" ulice="Jívová" zkrobchjm="ABRA Flexi s.r.o."/>
        <Veta1 dan23="0.0" dan5="0.0" dan_dzb23="0.0" dan_dzb5="0.0" dan_pdop_nrg="0.0" dan_psl23_e="0.0" dan_psl23_z="0.0" dan_psl5_e="0.0" dan_psl5_z="0.0" dan_pzb23="0.0" dan_pzb5="0.0" dan_rpren23="0.0" dan_rpren5="0.0" dov_zb23="0.0" dov_zb5="0.0" obrat23="0.0" obrat5="0.0" p_dop_nrg="0.0" p_sl23_e="0.0" p_sl23_z="0.0" p_sl5_e="0.0" p_sl5_z="0.0" p_zb23="0.0" p_zb5="0.0" rez_pren23="0.0" rez_pren5="0.0"/>
        <Veta2 dod_dop_nrg="0.0" dod_zb="0.0" pln_ost="0.0" pln_rez_pren="0.0" pln_sluzby="0.0" pln_vyvoz="0.0" pln_zaslani="0.0"/>
        <Veta3 dov_osv="0.0" opr_dluz="0.0" opr_verit="0.0" tri_dozb="0.0" tri_pozb="0.0"/>
        <Veta4 dov_cu="0.0" nar_maj="0.0" nar_zdp23="0.0" nar_zdp5="0.0" od_maj="0.0" od_zdp23="0.0" od_zdp5="0.0" odkr_maj="0.0" odkr_zdp23="0.0" odkr_zdp5="0.0" odp_cu="0.0" odp_cu_nar="0.0" odp_rez_nar="0.0" odp_rezim="0.0" odp_sum_kr="0.0" odp_sum_nar="0.0" odp_tuz23="0.0" odp_tuz23_nar="0.0" odp_tuz5="0.0" odp_tuz5_nar="0.0" pln23="0.0" pln5="0.0"/>
        <Veta5 koef_p20_nov="0.00" odp_uprav_kf="0.0" pln_nkf="0.0" plnosv_kf="0.0" plnosv_nkf="0.0"/>
        <Veta6 dan_vrac="0.0" dan_zocelk="0.0" dano="0.0" odp_zocelk="0.0"/>
    </DPHDP3>
</Pisemnost>

Výsledek volání

Pro rozpoznání, zda byla služba vykonána úspěšně, lze kontrolovat HTTP status odpovědi.

V případě úspěšného vykonání služby je vracen HTTP status 200 a dokument odpovídající vybranému formátu XML nebo PDF.

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

Příklady nevalidních volání

V případě nevalidních volání je obsahem popis chyby.

1. Špatně zadaný parametr zadání období

GET https://demo.flexibee.eu/c/demo/priznani-dph.xml?koeficient=0&rok=2015&mesic=1&druh=opravny&dodatecneOproti=1&datumZjisteni=2023-06-13

Výsledek je chyby je odpověď HTTP Status 400 Bad request a popis chyby:

<winstrom version="1.0">
<success>false</success>
<message>Parametr 'druh' má nepodporovanou hodnotu! Zvolte jednu z následujících možností: [radne, radneOpravne, dodatecne, dodatecneOpravne].</message>
</winstrom>

2. Chyba v případě, že původní přiznání je v jiném období než je zadáno období požadavku.

GET https://demo.flexibee.eu/c/demo/priznani-dph.xml?koeficient=100&rok=2023&mesic=1&druh=dodatecne&dodatecneOproti=15&datumZjisteni=2023-06-13

Výsledek je chyby je odpověď HTTP Status 400 Bad request a popis chyby:

<?xml version="1.0" ?>
<winstrom version="1.0">
<success>false</success>
<message>Opravované přiznání musí být ve stejném období (2023-3) jako opravné přiznání (2023-1).</message>
</winstrom>

3. Chybějící povinný parametr

GET https://demo.flexibee.eu/c/demo/priznani-dph.xml?koeficient=100&rok=2015&mesic=1&druh=dodatecne

Výsledek je chyby je odpověď HTTP Status 400 Bad request a popis chyby:

<winstrom version="1.0">
<success>false</success>
<message>K provedení operace je vyžadován parametr 'dodatecneOproti'</message>
</winstrom>

Uložené přiznání DPH

Již vygenerovaná příznání jsou uložena. Seznam uložených přiznání lze získat na adrese

GET

https://demo.flexibee.eu/c/demo/ulozene-priznani-dph/(rok={rok} AND mesic={mesic} AND ctvrtleti={ctvrtleti}).xml

Případně pomocí /query a parametry v těle:

GET

https://demo.flexibee.eu/c/demo/ulozene-priznani-dph/query

Tělo:

"rok":"2023","mesic":"1"

FAQ

Tvorba přiznání k DPH v aplikaci ABRA Flexi

Slovenské přiznání DPH

Export řádků uložených přiznání přes REST API

Legislativně daný číselník obsahující jednotlivé řádky DPH


​Potřebujete poradit?

V případě dotazů k aplikaci nás kontaktujte na podporaflexi@abra.eu případně prostřednictvím chat okna v pravém dolním rohu.


​

Související články
Přiznání DPH
Průvodce pro přiznání k DPH a kontrolní hlášení (GUI)
Souhrnné hlášení k DPH - REST API
Kontrolní hlášení - REST API
Práce pro střediska - REST API
Dostali jste odpověď na svou otázku?