Preskoči na glavno vsebino

Úhrada v hotovosti

Úhrada prijatej alebo vydanej faktúry v hotovosti v REST API

Avtor: Petr Pech

Vydanú alebo prijatú faktúru možno cez XML uhradiť v hotovosti — Flexi k nej sama vytvorí uhrádzajúci pokladničný doklad. Slúži na to vnorený element <hotovostni-uhrada>.


Základné volanie

<?xml version="1.0"?>
<winstrom version="1.0">
<faktura-vydana>
<!-- uhrazovaný doklad; může být i "faktura-prijata" -->
<id>code:FAKTURA1</id>
<!-- lze normálně uvést další vlastnosti dokladu jako při běžném importu -->
<hotovostni-uhrada>
<pokladna>code:POKLADNA KČ</pokladna> <!-- povinné -->
<typDokl>code:STANDARD</typDokl> <!-- povinné: typ vytvářeného pokladního dokladu -->
<uhrazujiciDokl>code:UHRADA1</uhrazujiciDokl> <!-- nepovinné -->
<kurzKDatuUhrady>true</kurzKDatuUhrady> <!-- nepovinné: true = kurz k datu úhrady, jinak kurz z uhrazované faktury -->
<castka>1000</castka>
<datumUhrady>2026-01-01</datumUhrady>
</hotovostni-uhrada>
</faktura-vydana>
</winstrom>

🚨 Elementy <pokladna> a <typDokl>povinné. Bez nich volanie skončí chybou 400 s kódom nestedObjectRequired: „Element [pokladna] je uvnitř elementu [hotovostni-uhrada] povinný."


Prehľad elementov

Element

Povinnosť

Význam

pokladna

povinné

Pokladňa, v ktorej vznikne uhrádzajúci doklad.

typDokl

povinné

Typ vytváraného pokladničného dokladu.

castka

podľa režimu

Uhrádzaná suma. Povinná v režime rozdilZauctovat, voliteľná v režime vychozi, ignorovaná v režime uplnaUhrada.

rezim

nepovinné

Režim úhrady, pozri nižšie. Bez uvedenia platí vychozi.

uhrazujiciDokl

nepovinné

Identifikátor uhrádzajúceho pokladničného dokladu, pozri nižšie.

datumUhrady

nepovinné

Dátum úhrady vo formáte YYYY-MM-DD.

kurzKDatuUhrady

nepovinné

true = použije sa kurz platný k dátumu úhrady, inak kurz prevzatý z uhrádzanej faktúry.

kurz + kurzMnozstvi

nepovinné

Vlastný kurz. Uvádzajú sa vždy oba, pozri nižšie.

rada

nepovinné

Dokladová rada vytváraného pokladničného dokladu. Štandardne sa berie z vybraného typu dokladu, prípadne z vybranej pokladne.


Režim úhrady

Pomocou tagu <rezim> možno ovplyvniť režim hotovostnej úhrady. Ak tag nie je uvedený alebo je prázdny, platí režim vychozi.

Hodnota

Správanie

vychozi

Správanie je ovplyvnené uvedením alebo neuvedením sumy. Ak je suma uvedená a rovná sa celkovej sume dokladu, dôjde k úplnej úhrade. Ak sa nerovná, dochádza k čiastočnej úhrade. Ak suma nie je uvedená, zistí sa z uhrádzaného dokladu a doklad je úplne uhradený.

uplnaUhrada

Suma sa neuvádza (ak sa uvedie, je ignorovaná). Dôjde k úplnej úhrade dokladu a výsledná suma sa zaokrúhli podľa nastavenia z formy úhrady alebo typu dokladu. Zaokrúhľovací rozdiel sa zaúčtuje do interných dokladov — zaokrúhlenie sa vykonáva iba pri tuzemskej mene.

rozdilZauctovat

Suma musí byť vždy uvedená. Ak sa nerovná celkovej sume, zaúčtuje sa rozdiel do interných dokladov. V opačnom prípade ide o úplnú úhradu dokladu a k zaúčtovaniu rozdielu nedochádza.

⚠️ Režim rozdilZauctovat bez elementu <castka> vráti 400 elementRequired: „Element 'castka' musí být uveden." Neplatná hodnota režimu vráti 400 elementInvalidValue.


Vlastný kurz

Hotovostnej úhrade možno tiež priamo vnútiť kurz a kurzové množstvo. Ak kurz vyplníte, je potrebné vyplniť aj kurzové množstvo — bez neho to nie je možné.

<?xml version="1.0"?>
<winstrom version="1.0">
<faktura-vydana>
<id>code:FAKTURA_1</id>
<hotovostni-uhrada>
<pokladna>code:POKLADNA EUR</pokladna>
<!-- není povinný; pokud by nebyl vyplněn, použije se kurz převzatý z uhrazované faktury -->
<kurz>25</kurz>
<kurzMnozstvi>1</kurzMnozstvi>
<typDokl>code:STANDARD</typDokl>
<castka>1000</castka>
<datumUhrady>2026-12-03</datumUhrady>
</hotovostni-uhrada>
</faktura-vydana>
</winstrom>


Identifikátor uhrádzajúceho dokladu

ID uhrádzajúceho pokladničného dokladu (tag <uhrazujiciDokl>) možno uviesť podľa obvyklých pravidiel a funguje nasledovne:

  • Nová úhrada — ak nie je uvedené, vždy sa vytvorí nový pokladničný doklad; ak teda naimportujete XML dvakrát, vytvoria sa dve úhrady. Ak je uvedené a doklad s daným ID neexistuje, založí sa.

  • Aktualizácia — ak doklad existuje, musí uhrádzať danú faktúru (inak ide o chybu). Znamená to, že sa má úhrada iba aktualizovať dostupnou sumou na uhrádzajúcom doklade. Ostatné parametre úhrady sa ignorujú.


Dokladová rada

V tagu <hotovostni-uhrada> možno uviesť ešte dokladovú radu pre vytváraný pokladničný doklad. Nie je to povinné a štandardne sa berie z vybraného typu dokladu, prípadne z vybranej pokladne.

<rada>code:POKLADNA+</rada>

ℹ️ Parameter <zbytek> sa pri hotovostnej úhrade nepoužíva — uhrádzajúci doklad si Flexi vytvára sama, takže rozdiel medzi sumami nemôže vzniknúť; výšku úhrady riadite elementmi <castka> a <rezim>. Popis hodnôt parametra zbytek nájdete v článku Párovanie platieb, kde sa tento parameter uvádza v elemente <sparovani>.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?