Souhrnné hlášení k DPH - REST API

Jak vytvořit souhrnné hlášení pomocí REST API Flexi

Ota Rádl avatar
Autor: Ota Rádl
Aktualizováno před více než týdnem

Stejně jako v aplikaci je možné získat v XML (PDF) i prostřednictví API Flexi.

Způsob volání

Lze využít HTTP metodu: GET.

Služba je dostupná na adrese: /c/{firma}/souhrnne-hlaseni, kde {firma} je databázový identifikátor firmy.

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

Parametry

Služba má 3 parametry, na pořadí parametrů nezáleží:

  • rok (povinný), ve tvaru ?stat=2023

  • mesic (povinný, není-li zadán parametr ctvrtleti), ve tvaru ?mesic=1

    • možné hodnoty jsou 1 - 12

  • ctvrtleti (povinný, není-li zadán parametr mesic), ve tvaru ?ctvrtleti=1

    • možné hodnoty jsou 1 - 4

  • stat (nepovinný), ve tvaru ?stat=CZ

    • možné hodnoty CZ nebo SK, pokud není zadán použije se stát legislativy

Ukázka volání

Kompletní nejjednodušší volání pak vypadá následovně:

GET https://demo.flexibee.eu:5434/c/demo/souhrnne-hlaseni.xml?mesic=1&rok=2023

Případně pro PDF:

GET https://demo.flexibee.eu:5434/c/demo/souhrnne-hlaseni.pdf?mesic=1&rok=2023


Výsledek volání

Výsledek je pak souhrnné hlášení v XML struktuře pro daňový portál pro CZ legislativu:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Pisemnost nazevSW="ABRA Flexi" verzeSW="2023.5.6">
<DPHSHV verzePis="01.01">
<VetaD ctvrt="4" d_poddp="29.11.2023" dokument="SHV" k_uladis="DPH" rok="2023" shvies_forma="R"/>
<VetaP c_pop="277" c_pracufo="3104" c_ufo="462" dic="12345678" naz_obce="Praha" opr_postaveni="jednatel" psc="10100" stat="ČESKÁ REPUBLIKA" typ_ds="P" ulice="Jeremiášova" zkrobchjm="ABRA Software a.s."/>
</DPHSHV>
</Pisemnost>

Případně obdobně v jiné sktruktuře pro SK legislativu:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dokument>
<hlavicka>
<identifikacneCislo>
<kodStatu>SK</kodStatu>
<dic>141414114</dic>
</identifikacneCislo>
<danovyUrad/>
<druhSV>
<riadny>1</riadny>
<opravny>0</opravny>
<dodatocny>0</dodatocny>
</druhSV>
<obdobie>
<mesiac>1</mesiac>
<stvrtrok/>
<rok>2023</rok>
</obdobie>
<obchodneMeno>
<riadok>ABRA SK s.r.o.</riadok>

atd.

Případně celý PDF soubor při volání s příponou .pdf

Příklady nevalidních volání

GET https://demo.flexibee.eu/c/demo/souhrnne-hlaseni.xml?mesic=2&rok=2023

V případě úspěšného vykonání služby je vracen HTTP status 200 společně s tělem v požadovaném formátu XML či PDF.

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

1. Nevalidní zadání období

GET https://demo.flexibee.eu/c/demo/souhrnne-hlaseni.xml?ctvrtleti=5&rok=2023

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

<winstrom version="1.0">
<success>false</success>
<message>Zadaný parametr čtvrtletí není v rozmezí povolených hodnot (1 - 4).</message>
</winstrom>

2. Nevalidní zadání státu

GET https://demo.flexibee.eu/c/demo/souhrnne-hlaseni.xml?ctvrtleti=1&rok=2023&stat=CS

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

<winstrom version="1.0">
<success>false</success>
<message>Parametr 'stat' má nepodporovanou hodnotu! Zvolte jednu z následujících možností: [CZ, SK]</message>
</winstrom>

4. Bez zadání všech povinných parametrů

GET https://demo.flexibee.eu/c/demo/souhrnne-hlaseni.pdf?rok=2023

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

<winstrom version="1.0">
<success>false</success>
<message>Není zadáno období pro zpracování souhrnného hlášení.</message>
</winstrom>

FAQ


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.

Dostali jste odpověď na svou otázku?