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, proto 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.
Nyní se však pojďme podívat, jak saldo vygenerovat v REST API rozhraní.
HTTP metoda
Saldo je dostupné pomocí HTTP metody GET.
Endpoint
Služba je dostupná na adrese: /c/{firma}/saldo, kde {firma} je databázový idenfitikátor firmy.
Parametry
Výstup salda lze ovlivnit následujícími parametry:
stavUhrady- Stav úhrady záznamů salda (možné hodnoty:uhrazeno,neuhrazeno). Pokud není parametr uveden, tak saldo vrací všechny záznamy nezávisle na stavu úhrady.filtrUcty- Filtrace záznamů salda pomocí účtů. Můžete zadat účty, prefix účtů, případně jejich rozsah, oddělené čárkou (př: 311000, 32, 3-4).filtrProtiucty- Filtrace záznamů salda pomocí protiúčtů. Můžete zadat účty, prefix účtů, případně jejich rozsah, oddělené čárkou (př: 211001, 21, 1-2).
Výše popsané parametry nejsou povinné, volání lze provést i bez nich.
URL adresa však může disponovat i obecnými parametry, jako je stránkování či úroveň detailu.
Ukázky volání
GET https://demo.flexibee.eu/c/demo/saldo.xmlGET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazenoGET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=neuhrazeno&filtrUcty=311001,311002GET https://demo.flexibee.eu/c/demo/saldo.xml?stavUhrady=uhrazeno&filtrUcty=311001&filtrProtiucty=1-2GET https://demo.flexibee.eu/c/demo/saldo/(firma='code:4219').xml
Ve všech případech je odpovědí HTTP 200 a požadované záznamy salda.
Ukázky výsledku
XML
<winstrom>
<saldo>
<stavUhrK></stavUhrK>
<datVyst>2018-01-08</datVyst>
<datSplat>2018-01-22</datSplat>
<mena evidencePath="mena" showAs="CZK: Česká koruna" ref="/v2/c/testovaci_2/mena/31.xml">code:CZK</mena>
<firma evidencePath="adresar" showAs="4219: Odběratel č. 55" ref="/v2/c/testovaci_2/adresar/654.xml">code:4219</firma>
</saldo>
<saldo>
<stavUhrK></stavUhrK>
<datVyst>2018-01-08</datVyst>
<datSplat>2018-01-22</datSplat>
<mena evidencePath="mena" showAs="CZK: Česká koruna" ref="/v2/c/testovaci_2/mena/31.xml">code:CZK</mena>
<firma evidencePath="adresar" showAs="4219: Odběratel č. 55" ref="/v2/c/testovaci_2/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":"/v2/c/testovaci_2/mena/31.json",
"firma":"code:4219",
"firma@evidencePath":"adresar",
"firma@showAs":"4219: Odběratel č. 55",
"firma@ref":"/v2/c/testovaci_2/adresar/654.json"
},
{
"stavUhrK":"",
"datVyst":"2018-01-08",
"datSplat":"2018-01-22",
"mena":"code:CZK",
"mena@evidencePath":"mena",
"mena@showAs":"CZK: Česká koruna",
"mena@ref":"/v2/c/testovaci_2/mena/31.json",
"firma":"code:4219",
"firma@evidencePath":"adresar",
"firma@showAs":"4219: Odběratel č. 55",
"firma@ref":"/v2/c/testovaci_2/adresar/654.json"
}
]
}
}
FAQ
Existuje dokumentace k jiným účetním výstupům?
Ano, naleznete ji na našem webu.
Jak přes API vygenerovat stav neuhrazených faktur?
Postup je popsán v naší dokumentaci.