Přeskočit na hlavní obsah

Stažení příkazu k úhradě přes API

Příklad URL adresy

Autor: Petr Pech

Elektronický příkaz k úhradě, který se jinak z aplikace ukládá do souboru pro internetové bankovnictví, lze stáhnout i přes REST API.


Stažení souboru

GET /c/{firma}/prikaz-k-uhrade/{id}/stazeni

Jednotlivé části adresy:

Část adresy

Význam

{firma}

Strojový identifikátor firmy.

prikaz-k-uhrade

Označení evidence.

{id}

Identifikátor příkazu k úhradě — interní číslo, kód nebo externí identifikátor.

stazeni

Endpoint, který vrátí samotný soubor.

Odpovědí je binární soubor (application/octet-stream) ve formátu, který je nastaven na bankovním účtu — pole Formát el. bank. pro příkazy (elBanFormatPrikaz). Volitelný parametr ?dat-splat-z-hlavicky=true přebere datum splatnosti z hlavičky příkazu místo z jednotlivých položek.

⚠️ Stáhnout lze jen příkaz ve stavu Neodesláno. Stažením se příkaz překlopí do stavu Odesláno a každý další pokus skončí chybou 400 se stránkou „Operaci nelze provést". Chcete-li soubor stáhnout znovu, zrušte nejprve odeslání: PUT /c/{firma}/prikaz-k-uhrade/{id}/zrusit-odeslani.


Další operace s příkazem

Operace

Adresa

Vytvoření příkazu

PUT /c/{firma}/prikaz-k-uhrade — hlavička s bankovním účtem a položkami; položka může místo čísla účtu odkazovat rovnou na hrazený doklad přes doklFak.

Odeslání do Fio banky

GET /c/{firma}/prikaz-k-uhrade/{id}/odeslani-fio — pouze pro Fio banku s online napojením.

Zrušení stavu odeslání

PUT /c/{firma}/prikaz-k-uhrade/{id}/zrusit-odeslani

💡 Příkaz k úhradě lze přes API i celý vytvořit — v položkách stačí uvést doklFak s odkazem na hrazenou fakturu a částku i účet si Flexi doplní z dokladu.


Související

Dostali jste odpověď na svou otázku?