Ve výpisu položek se nadřízený doklad vrací jen jako odkaz. Parametrem includes lze místo odkazu vložit do odpovědi rovnou i jeho vlastnosti — hodí se, když z pozice položky potřebujete třeba firmu z hlavičky dokladu.
Bez includes
Vazba na doklad je jen reference — víte, kam se podívat, ale data v odpovědi nemáte:
<doklFak ref="/c/{firma}/faktura-vydana/2859.xml" showAs="KBF1">code:KBF1</doklFak>
S includes
Cesta v parametru includes říká, která vazba se má rozbalit; detail=custom pak určuje, která pole z rozbaleného dokladu chcete:
GET /c/{firma}/faktura-vydana-polozka/(id eq 3595).xml
?detail=custom:nazev,mnozMj,doklFak(kod,firma)
&includes=/faktura-vydana-polozka/doklFak/
Odpověď má doklad rozbalený uvnitř položky:
<faktura-vydana-polozka>
<id>3595</id>
<nazev>FRadek 1</nazev>
<mnozMj>1.0</mnozMj>
<doklFak>
<faktura-vydana>
<id>2859</id>
<kod>KBF1</kod>
<firma>…</firma>
</faktura-vydana>
</doklFak>
</faktura-vydana-polozka>
ℹ️ Cesta v includes se skládá z názvů evidencí a vazeb, kterými se k cíli dostanete — začíná evidencí, na kterou se ptáte. Stejně to funguje i opačným směrem, tedy z hlavičky na ceník položky, nebo přes několik úrovní za sebou.
Týž princip u skladového dokladu — z položky na firmu z hlavičky:
GET /c/{firma}/skladovy-pohyb-polozka/(cenik.id eq 13).json
?detail=custom:nazev,mnozMj,cenik,doklSklad(firma)
&includes=/skladovy-pohyb-polozka/doklSklad/