Preskoči na glavno vsebino

Saldo - REST API

Akým spôsobom generovať účtovný výstup salda v REST API rozhraní?

Avtor: Petr Pech

Rovnako ako väčšinu účtovných výstupov je možné v REST API generovať aj saldo.

Saldo sa používa na zistenie saldokontného stavu dokladov. ABRA Flexi zoskupí pre daný saldo účet všetky zdroje a úhrady podľa čísla zdrojového dokladu — zdrojové doklady prenášajú do párovacieho symbolu svoj variabilný symbol a úhrady pomocou väzobnej tabuľky preberajú do párovacieho symbolu variabilný symbol zdroja.

Ak vás zaujíma dokumentácia pre desktopovú aplikáciu, pokračujte na tento odkaz.


Spôsob volania

Saldo je dostupné pomocou HTTP metódy GET na adrese /c/{firma}/saldo, kde {firma} je databázový identifikátor firmy.

GET https://demo.flexibee.eu/c/demo/saldo.xml

Výstup je možné ďalej ovplyvniť parametrami nižšie. Žiadny z nich nie je povinný a URL adresa môže niesť aj všeobecné parametre, ako je stránkovanie či úroveň detailu.


Parametre

Parameter

Význam

stavUhrady

Stav úhrady záznamov salda — uhrazeno alebo neuhrazeno. Ak nie je parameter uvedený, saldo vracia všetky záznamy nezávisle od stavu úhrady.

filtrUcty

Filtrácia pomocou účtov. Je možné zadať účty, prefix účtov, prípadne ich rozsah, oddelené čiarkou — napr. 311000, 32, 3-4.

filtrProtiucty

Filtrácia pomocou protiúčtov, rovnaký zápis — napr. 211001, 21, 1-2.

datumUctovaniOd
​datumUctovaniDo

Rozsah dátumu účtovania vo formáte yyyy-MM-dd. Obmedzí výpis iba na záznamy v danom rozsahu.

datumVystaveniOd
​datumVystaveniDo

Rozsah dátumu vystavenia dokladu vo formáte yyyy-MM-dd.

modul

Filtrácia podľa modulov účtovných dokladov; parameter je možné opakovať. Prípustné hodnoty: modulUcetni.FAP, modulUcetni.FAV, modulUcetni.BAN, modulUcetni.POK, modulUcetni.SKL, modulUcetni.INT, modulUcetni.PHL, modulUcetni.ZAV, modulUcetni.MAJ, modulUcetni.LEA, modulUcetni.TXP a modulUcetni.TXZ.

castkaMDOd, castkaMDDo
​castkaMDMenOd, castkaMDMenDo

Rozsah sumy MD v tuzemskej, respektíve v cudzej mene.

castkaDalOd, castkaDalDo
​castkaDalMenOd, castkaDalMenDo

Rozsah sumy Dal v tuzemskej, respektíve v cudzej mene.

stredisko, zakazka, firma

Filtrácia podľa strediska, zákazky alebo firmy. Parametre je možné opakovať, hodnota používa importný identifikátor — napr. code:CENTRALA.

stavZauctovani

Stav zaúčtovania dokladov — zauctovano, nezauctovano alebo vse.

popis

Fulltextová filtrácia podľa popisu.

cisloDokladu, varSymbol, parSymbol

Filtrácia podľa interného čísla dokladu, variabilného alebo párovacieho symbolu. Je možné zadať viac hodnôt oddelených čiarkou.

⚠️ Pri parametroch s výčtom hodnôt (stavUhrady, stavZauctovani, modul) skončí neplatná hodnota chybou 400 unsupported_param_value_exception a server v nej vypíše prípustné možnosti. Naopak neznámy názov parametra sa ignoruje bez chyby, takže preklep v názve sa nijako neprejaví — len sa neuplatní filtrácia.

ℹ️ Parameter modul sa tu zapisuje s prefixom modulUcetni., zatiaľ čo pri stave úhrad k dátumu sa uvádza len FAV, PHL, FAP a ZAV.


Ukážky volania

GET https://demo.flexibee.eu/c/demo/saldo.xml
GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazeno
GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazeno&filtrUcty=311001,311002
GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=uhrazeno&filtrUcty=311001&filtrProtiucty=1-2
GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazeno&datumUctovaniOd=2025-01-01&datumUctovaniDo=2025-01-31
GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazeno&datumVystaveniOd=2025-01-01&datumVystaveniDo=2025-01-31
GET https://demo.flexibee.eu/c/demo/saldo.xml?modul=modulUcetni.FAV&modul=modulUcetni.FAP&stredisko=code:CENTRALA&stavZauctovani=zauctovano
GET https://demo.flexibee.eu/c/demo/saldo.xml?castkaMDOd=1000&castkaMDDo=5000&varSymbol=2026001,2026002


Ukážka výstupu

XML:

<winstrom version="1.0">
<saldo>
<stavUhrK></stavUhrK>
<datVyst>2018-01-08</datVyst>
<datSplat>2018-01-22</datSplat>
<mena evidencePath="mena" showAs="CZK: Česká koruna"
ref="/c/demo/mena/31.xml">code:CZK</mena>
<firma evidencePath="adresar" showAs="4219: Odběratel č. 55"
ref="/c/demo/adresar/654.xml">code:4219</firma>
</saldo>
</winstrom>

JSON:

{
"winstrom": {
"@version": "1.0",
"saldo": [
{
"stavUhrK": "",
"datVyst": "2018-01-08",
"datSplat": "2018-01-22",
"mena": "code:CZK",
"mena@evidencePath": "mena",
"mena@showAs": "CZK: Česká koruna",
"mena@ref": "/c/demo/mena/31.json",
"firma": "code:4219",
"firma@evidencePath": "adresar",
"firma@showAs": "4219: Odběratel č. 55",
"firma@ref": "/c/demo/adresar/654.json"
}
]
}
}


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?