Zamykání období přes REST API

V API je dostupná evidence /zamek, která nabízí možnost zamknout období obdobně jako desktopová aplikace. Evidenci naleznete zde. Popis zamykání období v desktopové aplikaci naleznete v této dokumentaci.

Přes požadavky na API je možné zámky číst i zasílat. Data lze získat a zaslat ve formátu XML či JSON.

Čtení zámků

Zámky je možné načíst metodou GET na endpoint evidence /zamek. Při volání je možné využít standardní detail či filtraci. Uvedeme si příklad pro získání zámků:

GET https://demo.flexibee.eu/c/demo/zamek.xml?detail=full&limit=0

Získáme kompletní seznam zámků období v plném detailu ve formátu XML:

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
  <!-- Zámky na období -->
  <zamek>
    <!-- ID (celé číslo) - -->
    <id>3</id>
    <!-- Poslední změna (datum a čas) - -->
    <lastUpdate>2022-01-25T13:03:41.119+01:00</lastUpdate>
    <!-- Zámek
     Otevřeno - zamek.otevreno
     Zamknuto mimo účetní - zamek.polozamceno
     Zamknuto - zamek.zamceno -->
    <zamekK showAs="Zamknuto mimo účetní">zamek.polozamceno</zamekK>
    <!-- Od (datum) - -->
    <platiOdData>2021-10-01+02:00</platiOdData>
    <!-- Do (datum) - -->
    <platiDoData>2021-12-31+01:00</platiDoData>
    <!-- Faktury vydané (logická hodnota) - -->
    <modulFav>true</modulFav>
    <!-- Faktury přijaté (logická hodnota) - -->
    <modulFap>false</modulFap>
    ...
    <neucetni>true</neucetni>
  </zamek>
</winstrom>

Získáme informaci o typu zámku v elementu zamekK, dále výpis obsahuje všechny moduly a hodnotu true/false, který indikuje zda je modul zamčený.

Nastavení zámků

Požadavek na zamknutí zasíláme metodou POST na na endpoint evidence /zamek.

Tělo požadavku je možné zaslat v XML či JSON.

Povinné elementy v případě nastavení zámků jsou následující:

zamekK - definuje typ zámku, možné hodnoty jsou :
- Otevřeno (zamek.otevreno)
- Zamčeno mimo účetní (zamek.polozamceno)
- Zamčeno (zamek.zamceno)
platiOdData - definuje počáteční datum zámku ve formátu YYYY-MM-DD
platiDoData - definuje konečné datum zámku ve formátu YYYY-MM-DD

Při volání je také možné určit, zda se mají zamknout i neúčetní doklady:

neucetni - true/false, v případě true dojde k zamčení i neúčetních dokladů, výchozí hodnota je nastavena na true

Dalšími elementy jsou dostupné moduly, které je možné zamknou, nabývají hodnoty true pro zamknutí:

modulFav - Faktury vydané
modulFap - Faktury přijaté
modulPhl - Ostatní pohledávky
modulZav - Ostatní závazky
modulBan - Banka
modulPok - Pokladna
modulInt - Interní doklady
modulSkl - Skladové pohyby
modulPpp - Poptávky přijaté
modulPpv - Poptávky vydané
modulNap - Nabídky přijaté
modulNav - Nabídky vydané
modulObp - Objednávky přijaté
modulObv - Objednávky vydané
modulMaj - Majetek
modulLea - Leasing
modulMzd - Mzdy

Pokud není uveden alespoň jeden modul s hodnotou true, nedojde k zamčení.

Příklad volání metodou POST na endpoint:

POST https://demo.flexibee.eu/c/demo/zamek.xml

Tělo požadavku, které zamyká modul faktury přijaté kompletním zámkem:

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
  <zamek>
    <zamekK>zamek.zamceno</zamekK>
    <platiOdData>2022-01-01+02:00</platiOdData>
    <platiDoData>2022-01-15+01:00</platiDoData>
    <modulFap>true</modulFap>
  </zamek>
</winstrom>

Smazání zámku

Zámek období je možné smazat metodou POST a využitím akce delete:

POST https://demo.flexibee.eu/c/demo/zamek.xml

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
  <zamek action="delete">
    <id>6</id>
  </zamek>
</winstrom>

Odstranění zámku období neodemyká jednotlivé doklady! Doklady je nutné odemknout samostatně.