Veřejné rozhraní pro aplikace třetích stran modulu Mzdy

Veřejným rozhraním pro aplikace třetích stran modulu Mzdy je webová služba (WS).

WS obsahuje tři metody. Metodu ImportDochazky pro import docházky. Metodu GetPovoleneHodnotyPolozekDochazky, která vrací seznam povolených hodnot pro jednotlivé položky docházky. Metodu WSInfo pro zjištění základních informací o WS.

Metoda import docházky

Metoda ImportDochazky slouží pro import údajů docházky do mezd sql. Import se vždy provádí v dávce, tj. importují se všechny údaje docházky pro všechny zaměstnance za jeden měsíc najednou. Import se provádí vždy do posledního otevřeného roku a období ve mzdách (aktuální období). Před importem se provádí výmaz stávajících údajů. Položky docházky se importují za zaměstnance dle osobního čísla. Pro jednoho zaměstnance, lze provést import pouze jednoho pracovního poměru.

Tato metoda vyžaduje ověření. V hlavičce soap zprávy musí být předáno uživatelské jméno a heslo. Jméno a heslo se zadává do property SpcSoapHeaderValue webové služby viz příloha.

Vstupním parametrem metody ImportDochazky je třída ImportDochazkyVstup, která obsahuje property Rok, Mesic a PolozkyDochazky. Property Rok a Mesic jsou nepovinné (nullable) a slouží pouze pro kontrolu, zda se importuje dávka ze správného období. Například pokud je předán parametr Rok = 2016 a Mesic = 12 a mzdy sql mají aktuální období leden 2017 (prosinec 2016 je uzavřený), vrátí WS výjimku, „Období 12 v roce 2016 není aktuální a nelze do něho importovat docházku“. Pokud parametr Rok nebo Mesic není vyplněný, nekontroluje se. Property PolozkyDochazky je pole objektů typu PolozkaDochazky a slouží pro import jednotlivých položek docházky do mezd sql. Třída PolozkaDochazky obsahuje property OsobniCislo, TypPolozky, Dny, Hodiny, Castka, Pocet. OsobniCislo je osobní číslo zaměstnance, typu celé číslo a je povinné. TypPolozky je typ importované položky např. odpracovaná doba, výčtový typ viz příloha a je povinné. Dny je počet dnů např. 10 odpracovaných dnů, typu desetinné číslo a je nepovinné. Hodiny je počet hodin např. 28 odpracovaných hodin, typu desetinné číslo a je nepovinné. Castka je částka např. 1000,- Kč odměna, typu desetinné číslo a je nepovinná. Pocet je počet např. 5 obědů, typu desetinné číslo a je nepovinné. Pro každou položku docházky jsou povolené jiné kombinace plnění hodnot property Dny, Hodiny, Castka a Pocet, viz metoda GetPovoleneHodnotyPolozekDochazky. Například pro položku odpracovaná doba je povoleno vyplňovat pouze property Dny a Hodiny, property Castka a Pocet musí zůstat nevyplněné (null). Například pokud je pro typ položky odpracovaná doba vyplněna hodnota v property Castka, vrátí WS výjimku „Do položky OdpracovanaDoba není povoleno importovat částku.“.

Výstupním parametrem metody ImportDochazky je logická hodnota (true, false). V případě úspěšného importu je vrácena hodnota true, jinak false.

Metoda pro zjištění povolených hodnot pro jednotlivé položky docházky

Metoda GetPovoleneHodnotyPolozekDochazky slouží pro zjištění, které hodnoty je povoleno zadávat pro jednotlivé položky docházky.

Metoda nemá žádný vstupní parametr.

Výstupním parametrem metodyGetPovoleneHodnotyPolozekDochazky je pole obsahující seznam objektů typu PolozkaDochazkyPovoleneHodnoty. Třída PolozkaDochazkyPovoleneHodnoty obsahuje property TypPolozkyDochazky, IsDnyPovoleno, IsHodinyPovoleno, IsCastkaPovoleno, IsPocetPovoleno. Property TypPolozkyDochazky obsahuje typ položky docházky, pro kterou jsou povolené hodnoty definovány. Property IsDnyPovoleno obsahuje true v případě, když je povoleno zadávat property Dny, jinak obsahuje false. Property IsHodinyPovoleno obsahuje true v případě, když je povoleno zadávat property Hodiny, jinak obsahuje false. Property IsCastkaPovoleno obsahuje true v případě, když je povoleno zadávat property Castka, jinak obsahuje false. Property IsPocetPovoleno obsahuje true v případě, když je povoleno zadávat property Pocet, jinak obsahuje false.

Metoda informace o webové službě

Metoda WSInfo slouží pro zjištění základních informací o WS.

Metoda nemá žádný vstupní parametr.

Výstupním parametrem metody WSInfo je třída WSInfoVystup, která obsahuje property CisloVerze, SoftPCSqlServer, SoftPCDatabaze. CisloVerze obsahuje číslo verze WS. SoftPCSqlServer obsahuje adresu sql serveru, kam se import provádí. SoftPCDatabaze obsahuje databázi, kam se import provádí.

Přílohy

Seznam položek docházky, které lze importovat do mezd

• Fond pracovní doby hodiny
• Odpracovaná doba dny
• Odpracovaná doba hodiny
• Dovolená dny
• Dovolená hodiny
• Svátky dny
• Svátky hodiny
• Svátky částka
• Náhrady dny
• Náhrady hodiny
• Neplacené volno dny
• Neplacené volno hodiny
• Neomluvená absence dny
• Neomluvená absence hodiny
• Příplatek přesčasy v pracovní den hodiny
• Příplatek přesčasy v den pracovního volna hodiny
• Příplatek sobota, neděle hodiny
• Příplatek noc hodiny
• Cestovné částka
• Paušál částka
• Obědy částka
• Stravenky částka
• Pohotovosti pracovní dny hodiny
• Pohotovosti dny pracovního volna hodiny
• Příplatek prostředí hodiny
• Příplatek svátky hodiny
• Příplatek dělená směna hodiny
• Zvláštní příplatek údržba komunikací hodiny
• Příspěvek OOPP částka
• Neproplacené hodiny
• Neproplacené přesčasy hodiny
• Náhrady indispoziční volno dny
• Náhrady indispoziční volno hodiny

Příklad ověření metody pomocí SpcSoapHeaderValue

new WebReferenceImportDochazkyDoMezd.WSSoftPCImportDochazkyDoMezdSQL()
{
  SpcSoapHeaderValue = new WebReferenceImportDochazkyDoMezd.SpcSoapHeader()
  {
    UserName = Properties.Settings.Default.WebServiceUserName,
    Password = Properties.Settings.Default.WebServicePassword
  },
};

WSDL soubor s definicí webové služby

Odkaz ke stažení souboru ImporDochazky.wsdl s definicí WS.