Preskoči na glavno vsebino

Povinné položky importu

Povinnosť atribútov v REST API

Avtor: Lenka Haringerová

Pri exporte XML zo systému sa vyexportuje mnoho polí. Mnoho z nich je však len na čítanie (napr. aktuálna priemerná cena skladu), a tak ich nie je možné modifikovať. Zároveň nie je nutné uvádzať množstvo hodnôt, pretože sú buď predvolené, alebo sa preberajú z typu dokladu.


Pravidlá pre tvorbu XML

  • Zvyčajne platí, že je potrebné vypĺňať len tie údaje, ktoré musíte zadať v aplikácii pri ručnom zakladaní záznamu.

  • Niektoré položky je však potrebné uviesť, pretože aplikácia ponúkne ich predvolenú hodnotu, ale v importoch je nutné ich uviesť.

  • Takmer vždy je povinná položka typ dokladu (<typDokl/>). Tá určuje, akého typu daný doklad je (napr. faktúra, záloha a pod.).

  • Je potrebné uvádzať len hodnotu v tagu (bez atribútov). Atribúty ref a showAs sú ignorované a v exporte sú len na jednoduchšiu vizualizáciu pre používateľa.

  • Pri naviazaní na ďalší systém je potrebné uvádzať identifikátory. Tie môžu byť rôznych typov (code:, ext:, ean:, …).

  • V závislosti od typu dokladu sa Vám môže stať, že raz je nutné nejaký atribút uvádzať a inokedy nie.


Ako zistiť, ktoré položky sú povinné

Nemusíte hádať — prehľad vlastností evidencie to hovorí priamo. Každá položka vo výstupe /properties nesie príznaky mandatory a isWritable:

GET /c/<identifikátor firmy>/<evidence>/properties.xml
<property>
<propertyName>typDokl</propertyName>
<name>Typ dokladu</name>
<type>relation</type>
<mandatory>true</mandatory>
<isWritable>true</isWritable>
</property>

mandatory

Položka je povinná — bez nej import záznamu neprejde.

isWritable

Hodnota false znamená položku len na čítanie. Ak ju uvediete v importe, bude ignorovaná.

isOverWritable

Či je možné hodnotu prepísať, aj keď ju systém sám dopočítava.

💡 Pri vydanej faktúre má zo 179 vlastností príznak mandatory len deväť (medzi nimi typDokl, datVyst, kod a varSym) a 38 vlastností je len na čítanie. Oplatí sa teda si /properties raz prejsť, než budete importné XML skladať metódou pokus–omyl.


Overenie bez uloženia

Či je XML kompletné, si najjednoduchšie skontrolujete testovacím uložením — pridaním parametra ?dry-run=true sa záznam neuloží, ale prebehnú všetky validácie.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?