Preskoči na glavno vsebino

Získanie položiek dokladov

API mi na faktúre vydanej nevypisuje položky. Ako získam položky dokladov?

Avtor: Lenka Haringerová

Výpis faktúr, objednávok alebo skladových dokladov vracia v predvolenom stave len hlavičky. Položky a ďalšie naviazané evidencie sa do výstupu pridávajú zvlášť.


Parameter relations

Najjednoduchšie je vymenovať sub-evidencie v parametri relations:

GET /c/{firma}/faktura-vydana.xml                          … jen hlavičky
GET /c/{firma}/faktura-vydana.xml?relations=polozkyDokladu … i s položkami

Ktoré sub-evidencie je možné pri danej evidencii pripojiť, vypíše adresa /relations. Do parametra patrí hodnota z elementu url:

GET /c/{firma}/faktura-vydana/relations.xml

ℹ️ Pri dokladoch sa položky volajú polozkyDokladu — a to zhodne pri faktúrach, objednávkach, bankových aj skladových dokladoch. Staršie zápisy polozkyFaktury a polozkyObchDokladu fungujú len pri tej evidencii, ku ktorej patria.


Kedy sa položky objavia aj bez relations

Položky sa do odpovede dostanú tromi spôsobmi:

Situácia

Výsledok

Doklad adresovaný priamo identifikátorom — /faktura-vydana/123.xml

Položky sú vo výstupe automaticky.

Výpis alebo filter — /faktura-vydana/(kod eq '…').xml

Len hlavičky, kým nepridáte relations.

Relácia vymenovaná v detail=custom:…

Položky sú vo výstupe aj bez parametra relations.

💡 Ak nechcete ťahať z databázy celé položky, vymenujte rovno potrebné polia: ?detail=custom:kod,polozkyDokladu(nazev,mnozMj). Odpoveď je menšia a Flexi ju zostaví rýchlejšie — podrobnejšie v článku Problém s vracaním polí.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?