Pomocí REST API lze vytvořit fakturu ze záloh uhrazených bankou, pokladnou nebo vzájemným zápočtem.
Jedná se o obdobu služby „Vytvořit fakturu ze zálohy" nad vydanými či přijatými fakturami. Rozdíl je v tom, že z pozice desktopové aplikace službu spouštíte nad danou fakturou — zde, u funkce v API, potřebujete naopak identifikátor platby.
Postup může být považován za rychlejší oproti funkci pro odpočet zálohy nebo ZDD. Nepotřebujete zde identifikátor zálohy, nýbrž identifikátor platby.
Jak funkce funguje
Základ těla požadavku vypadá stejně jako u kterékoliv jiné faktury. Uvádí se do něj povinné i volitelné vlastnosti, jako je typDokl, cisDosle nebo datSplat. Veškeré dostupné vlastnosti naleznete v tzv. evidence listu.
Do elementu <vytvorZUhrazenychZaloh> je nutné uvést uhrazujiciDokl pro identifikaci dokladu, kterým byla záloha uhrazena:
<vytvorZUhrazenychZaloh>
<uhrazujiciDokl>code:B+0005/2022</uhrazujiciDokl>
</vytvorZUhrazenychZaloh>
Je rovněž potřeba element uhrazujiciEvidence pro identifikaci evidence, do které tento doklad spadá. Vybírat lze z banka, pokladni-pohyb a vzajemny-zapocet:
<vytvorZUhrazenychZaloh>
<uhrazujiciDokl>code:B+0005/2022</uhrazujiciDokl>
<uhrazujiciEvidence>banka</uhrazujiciEvidence>
</vytvorZUhrazenychZaloh>
🚨 Evidence pokladny se v tomto elementu jmenuje pokladni-pohyb, nikoli pokladna. Element je povinný a při chybné nebo chybějící hodnotě volání skončí chybou 400 s kódem akceEvidenceList: „Akce je dostupná pro evidence: banka, pokladni-pohyb, vzajemny-zapocet."
Omezení služby
Službu lze použít pouze pro stejné typy pohybu. V opačném případě volání končí chybou
400: „Typ pohybu zálohy (Výdej) musí být stejný jako typ pohybu nového dokladu (Příjem)."Službu lze použít pouze u nově vytvářených dokladů. V opačném případě volání končí chybou
400: „Akce „vytvorZUhrazenychZaloh" není povolena na existujících dokladech."Zálohy s výrobními čísly v současné době API nepodporuje.
Kompletní příklady
Vytvoření vydané faktury ze záloh uhrazených bankou:
<winstrom version="1.0">
<faktura-vydana>
<typDokl>code:FAKTURA</typDokl>
<cisDosle>123</cisDosle>
<datSplat>2022-01-17</datSplat>
<vytvorZUhrazenychZaloh>
<uhrazujiciDokl>code:B+0005/2022</uhrazujiciDokl>
<uhrazujiciEvidence>banka</uhrazujiciEvidence>
</vytvorZUhrazenychZaloh>
</faktura-vydana>
</winstrom>
Vytvoření přijaté faktury ze záloh uhrazených pokladnou:
<winstrom version="1.0">
<faktura-prijata>
<typDokl>code:FAKTURA</typDokl>
<cisDosle>123</cisDosle>
<datSplat>2022-01-17</datSplat>
<vytvorZUhrazenychZaloh>
<uhrazujiciDokl>code:P-0001/2022</uhrazujiciDokl>
<uhrazujiciEvidence>pokladni-pohyb</uhrazujiciEvidence>
</vytvorZUhrazenychZaloh>
</faktura-prijata>
</winstrom>