Částky k odpočtu - REST API

Od verze 2024.3 jsou k dispozici v API nové sub-evidence/relace pro odpočty záloh od faktury.

Zálohy k odpočtu
- Vrací seznam ZDD a neúčetních záloh, které lze od dané faktury odpočítat
Částky k odpočtu
- Vrací částky, která lze ještě od této zálohy / ZDD odpočítat. Obdobná struktura odpovědi jako u zálohy k odpočtu

Způsob volání

Lze využít HTTP metodu: GET

Subevidence jsou dostupné na adresách:

1. Zálohy k odpočtu

https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}/zalohy-k-odpoctu.xml, kde {firma} je databázový idenfitikátor firmy. a {ID} je identifikátor vybrané faktury.

případně volání jako relace: https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=zalohy-k-odpoctu

2. Částky k odpočtu

https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}/castky-k-odpoctu.xml, kde {firma} je databázový idenfitikátor firmy. a {ID} je identifikátor vybrané zálohové faktury nebo ZDD.

případně volání jako relace: https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=castky-k-odpoctu

Jsou podporovány výstupní formáty: XML nebo JSON, a další.

Parametry

Pro generování výstupu nejsou nutné žádné parametry.

Ukázka volání

1. Výpis záloh k odpočtu u vybrané faktury.

GET

https://demo.flexibee.eu/c/demo/faktura-vydana/123/zalohy-k-odpoctu.xml

Výstup:

<winstrom>
     <zaloha-k-odpoctu>
        <zaloha ref="/c/demo/faktura-vydana/126.xml" showAs="VF1-0005/2024">code:VF1-0005/2024</zaloha>
        <ucetni>true</ucetni>
        <sumOsv>0.0</sumOsv>
        <sumZklZakl>3305.79</sumZklZakl>
        <sumZklSniz>0.0</sumZklSniz>
        <sumZklSniz2>0.0</sumZklSniz2>
        <sumDphZakl>694.22</sumDphZakl>
        <sumDphSniz>0.0</sumDphSniz>
        <sumDphSniz2>0.0</sumDphSniz2>
        <sumCelkZakl>4000.01</sumCelkZakl>
        <sumCelkSniz>0.0</sumCelkSniz>
        <sumCelkSniz2>0.0</sumCelkSniz2>
    </zaloha-k-odpoctu>
    <zaloha-k-odpoctu>
        <zaloha ref="/c/demo/faktura-vydana/127.xml" showAs="VF2-0003/2024">code:VF2-0003/2024</zaloha>
        <ucetni>false</ucetni>
        <sumOsv>9500.0</sumOsv>
        <sumZklZakl>0.0</sumZklZakl>
        <sumZklSniz>0.0</sumZklSniz>
        <sumZklSniz2>0.0</sumZklSniz2>
        <sumDphZakl>0.0</sumDphZakl>
        <sumDphSniz>0.0</sumDphSniz>
        <sumDphSniz2>0.0</sumDphSniz2>
        <sumCelkZakl>0.0</sumCelkZakl>
        <sumCelkSniz>0.0</sumCelkSniz>
        <sumCelkSniz2>0.0</sumCelkSniz2>
    </zaloha-k-odpoctu>
</winstrom>

Vlastnosti výstupu

Vlastnost ucetni uvádí, jak bude účetně doklad odpočten:

true - daný doklad by se odpočítával jako ZDD,
false - daný doklad by se odpočítaval jako neúčetní záloha

Uvedené částky jsou v měně dokladu. Neúčetní zálohy mají částku pouze v poli sumOsv

2. Výpis částek k odpočtu dané zálohy

GET

https://demo.flexibee.eu/c/demo/faktura-vydana/126/castky-k-odpoctu.json

Výstup

{
    "winstrom": {
        "@version": "1.0",
        "castky-k-odpoctu": [
            {
                "zaloha": "code:VF1-0005/2024",
                "zaloha@ref": "/c/demo/faktura-vydana/126.json",
                "zaloha@showAs": "VF1-0005/2024",
                "ucetni": "true",
                "sumOsv": "0.0",
                "sumZklZakl": "3305.79",
                "sumZklSniz": "0.0",
                "sumZklSniz2": "0.0",
                "sumDphZakl": "694.22",
                "sumDphSniz": "0.0",
                "sumDphSniz2": "0.0",
                "sumCelkZakl": "4000.01",
                "sumCelkSniz": "0.0",
                "sumCelkSniz2": "0.0"
            }
        ]
    }
}

3. Výpis částek k odpočtu dané zálohy formou relace

GET

https://demo.flexibee.eu/c/demo/faktura-vydana/126.json?relations=castky-k-odpoctu

Výstup:

{
    "winstrom": {
        "faktura-vydana": [
            {
                "id": "126",
                "kod": "VF1-0005/2024",
                .....
                "odpocAuto": "true",
                "typDoklSkl": "code:STANDARD",
                "castky-k-odpoctu": [
                    {
                        "zaloha": "code:VF1-0005/2024",
                        "zaloha@ref": "/c/demo/faktura-vydana/126.json",
                        "zaloha@showAs": "VF1-0005/2024",
                        "ucetni": "true",
                        "sumOsv": "0.0",
                        "sumZklZakl": "3305.79",
                        "sumZklSniz": "0.0",
                        "sumZklSniz2": "0.0",
                        "sumDphZakl": "694.22",
                        "sumDphSniz": "0.0",
                        "sumDphSniz2": "0.0",
                        "sumCelkZakl": "4000.01",
                        "sumCelkSniz": "0.0",
                        "sumCelkSniz2": "0.0"
                    }
                ]
            }
        ]
    }
}

Výsledek volání

Pro rozpoznání, zda byla dotaz na API vykonán ú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.

V případě nevalidních volání je obsahem popis chyby. Prázdný výstup je validní. V případě, že od faktury nelze žádné doklady odpočítat, výstupem je prázdná odpověď (analogicky pro částky k odpočtu):

{
    "winstrom": {
        "@version": "1.0",
        "zaloha-k-odpoctu": []
    }
}

FAQ

Tvorba ZDD v API

Odpočty ZDD a záloh v API

Vazby ZDD v API

Jak poznám pomocí API kolik z částky ZDD je již využito?

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.