Preskoči na glavno vsebino

Odoslanie výplatnej pásky e-mailom - REST API

Ako pomocou API odoslať výplatnú pásku e-mailom?

Avtor: Petr Pech

Cez REST API je možné rozoslať výplatné pásky e-mailom. Ktoré mzdy sa majú odoslať, určuje filter v URL; pásky idú na e-mailové adresy, ktoré majú zamestnanci uvedené v personalistike na záložke Adresa ako kontaktné.


Predpoklady

Celé nastavenie vrátane Freemarker premenných pre šablónu popisuje článok Zasielanie výplatných pások cez SMTP.


Zostavenie URL

Služba je subevidenciou automaticky-odeslat nad evidenciou mzda a volá sa metódou PUT alebo POST. Do okrúhlych zátvoriek patrí filter, ktorý vyberie mzdy na odoslanie:

PUT https://demo.flexibee.eu/c/demo/mzda/(rok="2019" and mesic in ("1","2","3") and osbCis = "1")/automaticky-odeslat.xml?jeden-mail-prijemci=true

Vo filtri sa najčastejšie používajú vlastnosti evidencie mzda: rok, mesic a osbCis (osobné číslo zamestnanca). Filter je povinný — bez neho by išlo o výber všetkých miezd v databáze.

🚨 Volanie skutočne rozošle e-maily zamestnancom a nemá testovací režim. Pred spustením si preto vždy overte, ktoré mzdy filter vyberie — rovnaký filter stačí poslať metódou GET na /c/{firma}/mzda/(…).json?detail=custom:rok,mesic,osbCis.


Výsledok

Odpoveď má podobu štandardného výsledku importu so súhrnom v elemente stats. Ak filtru nezodpovedá žiadna mzda, vracia služba 400, success s hodnotou false a upozornenie mzdyNejsouZaznamy:

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
<success>false</success>
<stats>
<created>0</created>
<updated>0</updated>
<deleted>0</deleted>
<skipped>0</skipped>
<failed>1</failed>
</stats>
<results>
<result>
<warnings>
<warning messageCode="mzdyNejsouZaznamy">Pro zadaný filtr neexistují mzdy.</warning>
</warnings>
</result>
</results>
</winstrom>


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?