Přeskočit na hlavní obsah

Provádění akcí

Provádění akcí v REST API

Autor: Petr Pech

Při importu lze namísto běžného vytvoření či změny záznamu provést jinou akci, např. smazání či storno dokladu. K tomu slouží atribut action:

<?xml version="1.0"?>
<winstrom version="1.0">
<faktura-vydana action="delete">
<id>123</id>
<id>uuid:123456</id>
</faktura-vydana>
</winstrom>

Dostupné akce

Akce

Popis

Smazání
(delete)

Záznam bude smazán.

Storno
(storno)

Záznam bude stornován. Lze použít pouze pro doklady.

⚠️ Při provádění akcí nejsou záznamy jinak modifikovány, nemá tedy smysl uvádět jiné elementy než id. Zároveň musí záznamy již existovat — odkaz na neexistující ID skončí chybou 400 s kódem idNotFound. Nelze tedy např. vytvořit novou smazanou fakturu.

ℹ️ Pokud akci použijete nad evidencí, která ji nepodporuje (např. storno nad adresářem), server odpoví 400 s kódem importXmlActionNotSupported.


Akce na položkách

Akce lze vyvolávat také na položkách dokladu. Jen ne přímo, ale stejně jako při aktualizaci je zapotřebí uvést požadavek prostřednictvím kolekce položek na odpovídajícím dokladu.

Ukázka pro smazání položky s ID rovno 456 ve formátu XML:

<?xml version="1.0"?>
<winstrom version="1.0">
<faktura-vydana>
<id>123</id>
<polozkyFaktury>
<faktura-vydana-polozka id="456" action="delete"/>
</polozkyFaktury>
</faktura-vydana>
</winstrom>

Totéž ve formátu JSON:

{
"winstrom": {
"@version": "1.0",
"faktura-vydana": [
{
"id": "123",
"polozkyFaktury": [
{ "id": "456", "@action": "delete" }
]
}
]
}
}


Související

Dostali jste odpověď na svou otázku?