Od verzie 2024.3 sú v API k dispozícii dve 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é je možné od danej faktúry odpočítať.
Sumy k odpočtu — vracia sumy, ktoré je možné ešte od danej zálohy či ZDD odpočítať. Štruktúra odpovede je rovnaká ako pri zálohách k odpočtu.

💡 Obe sub-evidencie majú zhodných 12 vlastností — zaloha, ucetni, sumOsv, sumZklZakl, sumZklSniz, sumZklSniz2, sumDphZakl, sumDphSniz, sumDphSniz2, sumCelkZakl, sumCelkSniz a sumCelkSniz2.

Spôsob volania

Je možné využiť HTTP metódu GET. Sub-evidencie sú dostupné na nasledujúcich adresách, kde {firma} je identifikátor firmy a {ID} identifikátor vybranej faktúry (pri sumách k odpočtu identifikátor zálohovej faktúry alebo ZDD).

Zálohy k odpočtu:

GET https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}/zalohy-k-odpoctu.xml

Prípadne ako relácia:

GET https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=zalohy-k-odpoctu

Sumy k odpočtu:

GET https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}/castky-k-odpoctu.xml

Prípadne ako relácia:

GET https://demo.flexibee.eu/c/{firma}/faktura-vydana/{ID}.xml?relations=castky-k-odpoctu

Podporované sú výstupné formáty XML, JSON a ďalšie. Na generovanie výstupu nie sú potrebné žiadne parametre.

⚠️ Zoznam atribútov si vytiahnite z evidencií v jednotnom čísle — zaloha-k-odpoctu/properties a castky-k-odpoctu/properties. Adresa zalohy-k-odpoctu/properties (množné číslo) vracia 500, pretože ide o názov relácie, nie evidencie.

Výpis záloh k odpočtu pri vybranej faktúre

GET https://demo.flexibee.eu/c/demo/faktura-vydana/123/zalohy-k-odpoctu.xml

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é sumy sú v mene dokladu. Neúčtovné zálohy majú sumu iba v poli sumOsv.

Výpis súm k odpočtu danej zálohy

GET https://demo.flexibee.eu/c/demo/faktura-vydana/126/castky-k-odpoctu.json

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"
      }
    ]
  }
}

Výpis súm k odpočtu formou relácie

GET https://demo.flexibee.eu/c/demo/faktura-vydana/126.json?relations=castky-k-odpoctu

Výstup (skrátené o ostatné vlastnosti faktúry):

{
  "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

Na rozpoznanie, či bol dopyt na API vykonaný úspešne, je možné kontrolovať HTTP status odpovede. V prípade úspešného vykonania služby je vracaný status 200 a dokument zodpovedajúci vybranému formátu (XML, JSON…). V prípade neúspechu je vracaný status 4xx/5xx a správa o dôvode neúspechu; pri nevalidných volaniach je obsahom popis chyby.

Prázdny výstup je validný — ak od faktúry nie je možné odpočítať žiadne doklady, výstupom je prázdna odpoveď (analogicky pre sumy k odpočtu):

{
  "winstrom": {
    "@version": "1.0",
    "zaloha-k-odpoctu": []
  }
}

ℹ️ Prázdna odpoveď teda neznamená chybu. Naopak, chybný názov relácie vráti 404 s kódom adresaNeplatnaUrl, takže preklep v URL od prázdneho výsledku ľahko odlíšite.

Súvisiace

Sorodni članki

Sumy na odpočet - REST API