Od verzie 2024.3 sú v API k dispozícii nové sub-evidencie/relácie pre odpočty záloh od faktúry.
Zálohy k odpočtu
Vracia zoznam ZDD a neúčtovných záloh, ktoré možno od danej faktúry odpočítať
Čiastky k odpočtu
Vracia čiastky, ktoré možno ešte od tejto zálohy / ZDD odpočítať. Obdobná štruktúra odpovede ako pri zálohe k odpočtu
Spôsob volania
Možno využiť HTTP metódu: GET
Sub-evidencie sú 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ý identifikátor firmy. a {ID} je identifikátor vybranej faktúry.
prípadne volanie ako relácia:
https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=zalohy-k-odpoctu
2. Čiastky k odpočtu
https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}/castky-k-odpoctu.xml, kde {firma} je databázový identifikátor firmy. a {ID} je identifikátor vybranej zálohovej faktúry alebo ZDD.
prípadne volanie ako relácia:
https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=castky-k-odpoctu
Sú podporované výstupné formáty: XML alebo JSON, a ďalšie.
Parametre
Pre generovanie výstupu nie sú potrebné žiadne parametre.
Ukážka volania
1. Výpis záloh k odpočtu pri vybranej faktúre.
GET
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
Vlastnosť ucetni uvádza, ako bude doklad účtovne odpočítaný:
true- daný doklad by sa odpočítaval ako ZDD,false- daný doklad by sa odpočítaval ako neúčtovná záloha
Uvedené čiastky sú v mene dokladu. Neúčtovné zálohy majú čiastku iba v poli sumOsv
2. Výpis čiastok k odpočtu danej zálohy
GET
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 čiastok k odpočtu danej zálohy formou relácie
GET
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ýsledok volania
Pre rozpoznanie, či bol dotaz na API vykonaný úspešne, možno skontrolovať HTTP status odpovede.
V prípade úspešného vykonania služby je vrátený HTTP status 200 a dokument zodpovedajúci vybranému formátu XML alebo PDF.
V prípade neúspechu je vrátený status 4xx/5xx a správa o dôvode neúspechu.
V prípade neplatných volaní je obsahom popis chyby. Prázdny výstup je platný. V prípade, že od faktúry nie je možné žiadne doklady odpočítať, výstupom je prázdna odpoveď (analogicky pre čiastky k odpočtu):
{
"winstrom": {
"@version": "1.0",
"zaloha-k-odpoctu": []
}
}
FAQ
Potrebujete poradiť?
V prípade otázok k aplikácii nás kontaktujte na podporaflexi@abra.eu prípadne prostredníctvom okna chatu v pravom dolnom rohu.