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, preto 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.

Teraz sa však pozrime na to, ako saldo vygenerovať v rozhraní REST API.

HTTP metóda

Saldo je dostupné pomocou HTTP metódy GET.

Endpoint

Služba je dostupná na adrese: /c/{firma}/saldo, kde {firma} je databázový identifikátor firmy.

Parametre

Výstup salda možno ovplyvniť nasledujúcimi parametrami:

stavUhrady - Stav úhrady záznamov salda (možné hodnoty: uhrazeno, neuhrazeno). Ak parameter nie je uvedený, saldo vracia všetky záznamy nezávisle od stavu úhrady.
filtrUcty - Filtrácia záznamov salda pomocou účtov. Môžete zadať účty, prefix účtov, prípadne ich rozsah, oddelené čiarkou (príkl.: 311000, 32, 3-4).
filtrProtiucty - Filtrácia záznamov salda pomocou protiúčtov. Môžete zadať účty, prefix účtov, prípadne ich rozsah, oddelené čiarkou (príkl.: 211001, 21, 1-2).

Vyššie popísané parametre nie sú povinné, volanie možno vykonať aj bez nich.

URL adresa však môže disponovať aj všeobecnými parametrami, ako je stránkovanie či úroveň detailu.

Ukážky volaní

Vo všetkých prípadoch je odpoveďou HTTP 200 a požadované záznamy salda.

Vývojárska dokumentácia

Ukážky 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"
         }
      ]
   }
}