Stejně jako většinu účetních výstupů je možné v REST API generovat i saldo.
Saldo se používá pro zjištění saldokontního stavu dokladů. ABRA Flexi seskupí pro daný saldo účet všechny zdroje a úhrady podle čísla zdrojového dokladu — zdrojové doklady přenášejí do párovacího symbolu svůj variabilní symbol a úhrady pomocí vazební tabulky přebírají do párovacího symbolu variabilní symbol zdroje.
Pokud vás zajímá dokumentace pro desktopovou aplikaci, pokračujte na tento odkaz.
Způsob volání
Saldo je dostupné pomocí HTTP metody 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 lze dále ovlivnit parametry níže. Žádný z nich není povinný a URL adresa může nést i obecné parametry, jako je stránkování či úroveň detailu.
Parametry
Parametr | Význam |
| Stav úhrady záznamů salda — |
| Filtrace pomocí účtů. Lze zadat účty, prefix účtů, případně jejich rozsah, oddělené čárkou — např. |
| Filtrace pomocí protiúčtů, stejný zápis — např. |
| Rozsah data účtování ve formátu |
| Rozsah data vystavení dokladu ve formátu |
| Filtrace podle modulů účetních dokladů; parametr lze opakovat. Přípustné hodnoty: |
| Rozsah částky MD v tuzemské, respektive v cizí měně. |
| Rozsah částky Dal v tuzemské, respektive v cizí měně. |
| Filtrace podle střediska, zakázky nebo firmy. Parametry lze opakovat, hodnota používá importní identifikátor — např. |
| Stav zaúčtování dokladů — |
| Fulltextová filtrace podle popisu. |
| Filtrace podle interního čísla dokladu, variabilního nebo párovacího symbolu. Lze zadat více hodnot oddělených čárkou. |
⚠️ U parametrů s výčtem hodnot (stavUhrady, stavZauctovani, modul) skončí neplatná hodnota chybou 400 unsupported_param_value_exception a server v ní vypíše přípustné možnosti. Naopak neznámý název parametru se ignoruje bez chyby, takže překlep v názvu se nijak neprojeví — jen se neuplatní filtrace.
ℹ️ Parametr modul se zde zapisuje s prefixem modulUcetni., zatímco u stavu úhrad k datu se uvádí jen FAV, PHL, FAP a ZAV.
Ukázky volání
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ázka 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"
}
]
}
}