Příkaz k inkasu lze vytvářet přes REST API jednoduchým voláním metodou PUT nebo POST nad konkrétním bankovním účtem.
Způsob volání
URL | Popis |
| Pro zadaný bankovní účet vytvoří příkaz k inkasu ze všech dosud neuhrazených dokladů. |
| Pro zadaný bankovní účet vytvoří příkaz k inkasu se zadanou splatností ze všech dosud neuhrazených dokladů v uvedeném období. |
Vstupy
Zpracování požadavku se řídí těmito parametry:
Parametr | Typ | Popis | Výchozí hodnota |
| datum | Datum splatnosti příkazu. | následující všední den |
| datum | Datum vystavení nejstaršího hrazeného dokladu. | neomezeno |
| datum | Datum vystavení nejmladšího hrazeného dokladu. | aktuální datum |
ℹ️ Datum se zde zadává v ISO formátu yyyy-mm-dd — pozor, u bankovní a pokladní knihy se naopak používá formát d.M.yyyy.
Které doklady se zařadí
Do vytvářeného příkazu k inkasu jsou zahrnuty doklady splňující tyto podmínky:
doklad je typu vydaná faktura nebo pohledávka s kladnou (nenulovou) hodnotou,
doklad je typu přijatá faktura nebo závazek se zápornou (nenulovou) hodnotou,
nejedná se o zálohový daňový doklad,
forma úhrady dokladu je „převodem",
doklad má vyplněné bankovní spojení (číslo účtu),
měna dokladu je shodná s měnou účtu,
doklad ještě není zcela uhrazen (může být částečně),
doklad se dosud nevyskytuje na příkazu k inkasu,
na dokladu není nastaven zákaz proplacení (faktura přijatá),
doklad je schválen k platbě, je-li vyžadován podpis před vystavením příkazu k úhradě,
datum vystavení dokladu vyhovuje zadaným kritériím (viz parametry
datVystOdadatVystDo).
Výstupy
Úspěšné zpracování požadavku může vracet tyto stavy:
Status | Význam |
| Nebyly nalezeny žádné vhodné doklady pro vytvoření příkazu. |
| Příkaz k inkasu byl vytvořen, URL je uvedeno v hlavičce |
⚠️ Status 200 tedy neznamená, že příkaz vznikl — vznik příkazu poznáte podle 201 a hlavičky Location. Metoda GET na této adrese vrací 405 Method Not Allowed.
Související
Příkaz k úhradě (REST API)
Příkaz k inkasu (aplikace)
Příkaz k inkasu (nastavení)
