Přes REST API (i přes webové rozhraní) lze vygenerovat faktury ze smluv (buďto všech nebo jedné konkrétní). Jde o jednoduché volání přes PUT nebo POST:
/c/firma/smlouva/generovani-faktur.xml | Vygeneruje faktury pro všechny smlouvy |
|---|---|
/c/firma/smlouva/1/generovani-faktur.xml | Vygeneruje faktury pro smlouvu s ID 1 |
Při volání přes REST API má odpověď (ve formátu XML) následující podobu:
<winstrom version="1.0">
<operation>Generování faktur</operation>
<success>ok</success>
<messages>
<message>Počet úspěšně vygenerovaných faktur: 1</message>
</messages>
<errors>
<error>...</error>
</errors>
</winstrom>
Element success může nabývat hodnot ok, partial, failed a unknown:
ok | Vygenerování faktur proběhlo v pořádku (ale nemusely být vygenerovány žádné faktury, pokud to nebylo potřeba) |
|---|---|
partial | Pro některé smlouvy proběhlo vygenerování faktur v pořádku, ale u jiných smluv došlo k chybě |
failed | Nebyly vygenerovány žádné faktury, u některých smluv došlo k chybě |
unknown | Nemělo by nikdy nastat |
Elementy message obsahují hlášení o úspěchu (nejvýše jedno), elementy error chybová hlášení (jedno pro každou smlouvu, u které došlo k chybě).