Přeskočit na hlavní obsah

Příkaz k inkasu

Jak vytvořit příkazu k inkasu přes REST API?

Autor: Petr Pech

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

/c/{firma}/bankovni-ucet/{id}/prikaz-k-inkasu

Pro zadaný bankovní účet vytvoří příkaz k inkasu ze všech dosud neuhrazených dokladů.

/c/{firma}/bankovni-ucet/{id}/prikaz-k-inkasu?splatnost=2014-10-14&datVystOd=2014-09-01&datVystDo=2014-09-30

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

splatnost

datum yyyy-mm-dd

Datum splatnosti příkazu.

následující všední den

datVystOd

datum yyyy-mm-dd

Datum vystavení nejstaršího hrazeného dokladu.

neomezeno

datVystDo

datum yyyy-mm-dd

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 datVystOd a datVystDo).


Výstupy

Úspěšné zpracování požadavku může vracet tyto stavy:

Status

Význam

200

Nebyly nalezeny žádné vhodné doklady pro vytvoření příkazu.

201

Příkaz k inkasu byl vytvořen, URL je uvedeno v hlavičce Location.

⚠️ 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í

Dostali jste odpověď na svou otázku?