Preskoči na glavno vsebino

Nastavenie spoločnosti – API

Ako cez REST API vytvoriť nové nastavenie firmy platné od určitého dátumu, prípadne nové počiatočné nastavenie pred tým existujúcim.

Avtor: Petr Pech

Nastavenie firmy, ktoré v aplikácii nájdete v sekcii Firma → Nastavení, je v ABRA Flexi vedené podľa časových platností — každý záznam evidencie nastaveni platí od určitého dátumu. Cez REST API je možné nastavenie ako čítať, tak zakladať ďalšie nastavenie platné od zvoleného dátumu aj nové počiatočné nastavenie pred tým, ktoré už existuje.


Získanie nastavenia firmy

Nastavenie je dostupné v XML aj JSON, celý obsah získate metódou GET s plnou úrovňou detailu:

GET /c/{firma}/nastaveni.xml?detail=full

Výstup XML vyzerá nasledovne:

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
<!-- Nastavení -->
<nastaveni>
<!-- ID (celé číslo) -->
<id>1</id>
<!-- Poslední změna (datum a čas) -->
<lastUpdate>2020-12-08T15:49:29.868+01:00</lastUpdate>
<!-- Změny budou platné od data (datum) -->
<platiOdData></platiOdData>
<!-- Jméno (řetězec) - max. délka: 255 -->
<nazFirmy>Demo firma</nazFirmy>
...
</nastaveni>
<nastaveni>
<id>2</id>
<nazFirmy>Demo firma s.r.o.</nazFirmy>
...
</nastaveni>
</winstrom>

Prehľad samotných platností získate obmedzením detailu:

GET /c/{firma}/nastaveni.xml?detail=custom:id,platiOdData

Nastavenia sú teda uložené ako jednotlivé verzie, podobne ako v desktopovej aplikácii:


Nové nastavenie platné od určitého dátumu

Ak vytvárame nové nastavenie platné od určitého dátumu, je potrebné uviesť pôvodné nastavenie, z ktorého má nové nastavenie vychádzať. Slúži na to vlastnosť puvodniNastaveni. Ostatné neuvedené informácie zostanú totožné ako v pôvodnom nastavení.

<winstrom version="1.0"> 
<nastaveni>
<puvodniNastaveni>
<id>1</id>
</puvodniNastaveni>
<platiOdData>2026-12-29</platiOdData>
<uliceNazev>Přestěhovaná</uliceNazev>
<!-- Další vlastnosti evidence "nastaveni", které chceme uložit. -->
</nastaveni>
</winstrom>

Požiadavku pošlite metódou PUT alebo POST na /c/{firma}/nastaveni.xml.


Počiatočné (prvé) nastavenie

Ak chceme vytvoriť počiatočné nastavenie firmy pred už existujúcim počiatočným nastavením, je potrebné uviesť vnútri elementu puvodniNastaveni ďalšie dve vlastnosti:

Vlastnosť

Význam

prvniNastaveni

Príznak, že vytvárame prvé nastavenie. Hodnota true.

prvniNastaveniPlatiDoData

Dátum, do kedy má toto nastavenie platiť. Bude automaticky nastavený už existujúcemu počiatočnému nastaveniu ako platiOdData.

<winstrom version="1.0"> 
<nastaveni>
<puvodniNastaveni>
<id>1</id>
<prvniNastaveni>true</prvniNastaveni>
<prvniNastaveniPlatiDoData>2026-12-22</prvniNastaveniPlatiDoData>
</puvodniNastaveni>
<!-- Vlastnosti evidence "nastaveni", které chceme uložit. -->
</nastaveni>
</winstrom>

⚠️ Dátum v prvniNastaveniPlatiDoData musí predchádzať platnosti existujúceho počiatočného nastavenia. Ak ju presahuje, server vráti 400 s kódom nastaveniVytvorPrvniNastNeplatneDatum a hlásením, že dátum zadaného počiatočného nastavenia je nekorektný.


Na čo si dať pozor

⚠️ Vlastnosti puvodniNastaveni, prvniNastaveni a prvniNastaveniPlatiDoData slúžia iba pre import — v zozname polí evidencie (/c/{firma}/nastaveni/properties) ich nenájdete a pri exporte sa nevracajú.

💡 Než požiadavku pošlete naostro, vyskúšajte si ju v režime testovacieho uloženia doplnením parametra ?dry-run=true. Server dáta zvaliduje, ale nič neuloží.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?