Resurssit - Palkansaajat, palkkaperusteet ja palkkalaskelmat
Palkansaajien ja palkkalaskelmien käsittelyn toiminnot jakautuvat seuraaviin toimintoihin:
| Integraatio | HTTP-metodi | Resurssi | DTD | Esimerkki |
| Palkansaajan tuonti | POST | employee.nv | employee.dtd | Lataa xml |
| Palkansaajalistauksen nouto palkkaperusteita varten | GET | getemployeesalaryparameterslist.nv | ||
| Palkansaajan palkkaperusteiden nouto | GET | getemployeesalaryparameters.nv | ||
| Palkansaajan palkkaperusteiden tuonti | POST | employeesalaryparameters.nv | employeesalaryparameters.xsd | Lataa xml |
| Palkkalajien nouto | GET | payrollratiolist.nv | ||
| Palkkalaskelman tuonti | POST | payrollpaycheckbatch.nv | payrollpaycheckbatch.dtd | |
| Palkkajaksokohtaisen kirjausrivin tuonti | POST | payrollperiodcollector.nv | payrollperiodcollector.dtd | |
| Palkkaennakon tuonti | POST | payrolladvance.nv | payrolladvance.dtd | |
| Ulkoisen palkanmaksuaineiston tuonti | POST | payrollexternalsalarypayment.nv | payrollexternalsalarypayment.dtd |
Resurssi: employee.nv
Palkansaajan tietojen tuonti Netvisoriin.
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| Method | 1 | Add | Tuonnin tyyppi, Add tai Edit |
Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):
| Taso | Elementti | Muoto ja pituus | Ilmentymiä | Kuvaus | Esimerkki |
| Root | root | Aggregaatti | 1 | ||
| 1 | employee | Aggregaatti | 1 | ||
| 2 | employeebaseinformation | Aggregaatti | 1 | ||
| 3 | employeeidentifier | Merkkijono | 1 | Palkansaajan tunniste | 010277-xxxp |
| 3 | firstname | Merkkijono, maks. 50 | 1 | Palkansaajan etunimi | Anna |
| 3 | lastname | Merkkijono, maks. 50 | 1 | Palkansaajan sukunimi | Asiakas |
| 3 | phonenumber | Merkkijono, maks. 50 | 1 | Palkansaajan puhelinnumero | 050 123 456 |
| 3 | Merkkijono, maks. 100 | 1 | Palkansaajan sähköpostiosoite | anna.asiakas@yritys.fi | |
| 2 | employeepayrollinformation | 1 | |||
| 3 | streetaddress | Merkkijono, maks. 255 | 1 | Palkansaajan katuosoite | Keisarinnankatu 1 |
| 3 | postnumber | Merkkijono, maks. 50 | 1 | Palkansaajan postinumero | 56120 |
| 3 | city | Merkkijono, maks. 255 | 1 | Palkansaajan postitoimipaikka | Lappeenranta |
| 3 | municipality | Merkkijono, maks. 255 | 1 | Palkansaajan asuinpaikkakunta | Lappeenranta |
| 3 | country | Merkkijono, maks. 2 | 0...1 | Palkansaajan kotimaan koodi, oletus fi | fi |
| 3 | nationality | Merkkijono, maks. 2 | 0...1 | Palkansaajan kansalaisuus, oletus fi | se |
| 3 | language | Merkkijono, maks. 2 | 0...1 | Palkansaajan käyttämä kieli, oletus fi | fi |
| 3 | employeenumber | Numeerinen | 0...1 | Palkansaajan yksilöllinen tunnistenumero | 13 |
| 3 | profession | Merkkijono, maks. 255 | 1 | Palkansaajan ammattinimike | Myyjä |
| 3 | jobbegindate | Merkkijono, maks. 10 | 1 | Palkansaajan työsuhteen alkamispäivä | 2011-09-03 |
| Attribuutti | format | Merkkijono | 1 | Alkamispäivän muoto, aina ansi | ansi |
| 3 | payrollrulegroupname | Merkkijono, maks. 50 | 1 | Palkansaajan palkkamallin nimi | Kuukausipalkkalaiset |
| 3 | bankaccountnumber | Merkkijono, maks. 34 | 0...1 | Palkansaajan pankkiyhteys eli pankkitilinumero | FI21 1234 xxxx xxxx xx |
| 3 | bankidentificationcode | Merkkijono. maks. 20 | 0...1 | Pankin tunniste | NDEAFIHH |
| 3 | accountingaccountnumber | Numeerinen | 0...1 | Palkansaajan velkatilinumero | 1751 |
Palkansaajalistauksen nouto palkkaperusteita varten
Resurssi: getemployeesalaryparameterslist.nv
Resurssilla voi hakea listauksen palkansaajista, joiden palkkaperusteita voidaan rajapinnan kautta käsitellä.
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| root | root | Aggregaatti | 1 | ||
| 1 | employees | Aggregaatti | 1 | ||
| 2 | employee | Aggregaatti | 0...n | ||
| 3 | pin | Merkkijono | 1 | Palkansaajan HETU | 123456-123A |
| 3 | number | Numero | 1 | Palkansaajan numero | 123 |
Palkansaajan palkkaperusteiden nouto
Resurssi: getemployeesalaryparameters.nv
Jos palkkaperusteella ei ole arvoa, palautuu value-elementti tyhjänä elementtinä (<value/>), kun taas nolla-arvo palautuu normaalina arvona (<value>0,0</value>).
Resurssin kautta voi hakea halutun palkansaajan palkkaperusteet. Kutsussa käytettävät parametrit (GET):
| Taso | Ilmentymiä | Kuvaus |
| identifiertype | 1 | Arvo: pin = palkansaajan HETU tai number = palkansaajan numero |
| identifier | 1 |
Tyypin mukainen tunniste: palkansaajan HETU tai palkansaajan numero |
Vastaus:
| Parametri | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| root | root | Aggregaatti | 1 | ||
| 1 | employeesalaryparameters | Aggregaatti | 1 | ||
| 2 | salaryparameters | Aggregaatti | 1 | ||
| 3 | parameter | Aggregaatti | 0...n | ||
| 4 | rationumber | Numero | 1 | Palkkaperusteen numero | 123 |
| 4 | value | Desimaaliluku | 1 | Palkkaperusteen arvo | 12,34 |
Palkansaajan palkkaperusteiden tuonti
Resurssi: employeesalaryparameters.nv
Sanomalla voi tuoda osan palkkaperusteista (1-24 kpl kerralla) ja toisella sanomalla eri osan palkkaperusteista. Palkkaperusteisiin joita sanomalla ei ole määritettynä ei tehdä muutoksia.
Jos palkkaperuste halutaan asettaa nollaksi tai sen arvoa halutaan päivittää, annetaan value-elementissä uusi arvo. Mikäli olemassaolevan palkkaperusteen arvo halutaan poistaa kokonaan, value-elementtiä ei anneta sanomalla.
Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):
| Taso | Elementti | Muoto ja pituus | Ilmentymiä | Kuvaus | Esimerkki |
| Root | root | Aggregaatti | 1 | ||
| 1 | employeesalaryparameters | Aggregaatti | 1 | ||
| 2 | employeeidentification | Teksti | 1 | Palkansaajan tunniste | 123456-123A |
| Attribuutti | Type | Teksti | 1 |
Palkansaajan tunnisteen tyyppi: |
pin |
| 2 | salaryparameters | Aggregaatti | 1 | ||
| 3 | salaryparameter | Aggregaatti | 1...24 | ||
| 4 | rationumber | Numero | 1 | Palkkaperusteen numero | 123 |
| 4 | value | Desimaaliluku | 0...1 | Palkkaperusteen arvo | 12,30 |
Resurssi:payrollratiolist.nv
Resurssilla voi hakea yrityskohtaiset palkkalajit. Palkkalajeja käytetään matkalaskun ja palkkalaskelman tuonnissa Netvisoriin.
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| Source | 1...n | collectorratiolines |
Tulee rajata palkkalajin tyypillä joka on oltava yksi tai useampi seuraavista:
|
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | root | Aggregaatti | 1 | ||
| 1 | PayrollRatios | Aggregaatti | 1 | ||
| 2 | PayrollRatio | Aggregaatti | 0...n | ||
| 3 | Name | Teksti | 1-3 | Palkkalajin nimi | Ulkomaan päiväraha |
| Attribuutti | ISO639-1Code | Teksti | 1 | Palkkalajin nimen kielitieto: fi,se, en | fi |
| 3 | Identifier | Numero | 1 | Palkkalajin ID | 1 |
| 3 | Source | Teksti | 1 | Palkkalajin tyyppi | Matkalasku, kulurivit |
| 3 | RatioNumber | Numero | 1 | Palkkalajin numero | 123 |
| 3 | DefaultDebitAccountNumber | Numero | 1 | Kirjanpidon debet-tili | 7890 |
| 3 | DefaultCreditAccountNumber | Numero | 1 | Kirjanpidon kredit-tili | 2961 |
Resurssi: payrollpaycheckbatch.nv
Palkkalaskelman tuonti Netvisoriin.
Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | root | Aggregaatti | 1 | ||
| 1 | payrollcheckbatch | Aggregaatti | 1 | ||
| 2 | employeeidentifier | Merkkijono | 1 | Tieto, jolla työntekijä linkitetään *1) | 140785-xxxx |
| Attribuutti | type | Merkkijono | 1 | Linkitystyyppi, employeenumber tai finnishpersonalidentifier | finnishpersonalidentifier |
| 2 | rulegroupperiodstart | Päivämäärä | 1 | Palkkajakson alkupäivämäärä *1) | 2009-12-31 |
| Attribuutti | format | Merkkijono | 1 | Päivämäärän muoto aina ansi | ansi |
| 2 | rulegroupperiodend | Päivämäärä | 1 | Palkkajakson loppupäivämäärä *2) | 2009-12-31 |
| Attribuutti | format | Merkkijono | 1 | Päivämäärän muoto, aina ansi | ansi |
| 2 | freetextbeforelines | Merkkijono | 0...1 | Vapaa teksti ennen palkkalaskelman rivejä | |
| 2 | freetextafterlines | Merkkijono | 0...1 | Vapaa teksti rivien jälkeen | |
| 2 | duedate | Päivämäärä | 0...1 | Eräpäivä | 2009-12-31 |
| Attribuutti | format | Merkkijono | 1 | Päivämäärän muoto, aina ansi | ansi |
| 2 | valuedate | Päivämäärä | 0...1 | 2009-12-31 | |
| Attribuutti | format | Merkkijono | 1 | Päivämäärän muoto, aina ansi | ansi |
| 2 | payrollcheckbatchline | Aggregaatti | 1...n | ||
| 3 | payrollratioidentifier | Merkkijono | 1 | Tieto, jolla palkkalaji linkitetään riviin | 1 |
| Attribuutti | type | Merkkijono | 1 | Linkitystyyppi, toistaiseksi vain rationumber | rationumber |
| 3 | units | Numeerinen | 1 | Rivin kappalemäärä | 2 |
| 3 | unitamount | Numeerinen | 1 | Yksikköhinta | 1500 |
| 3 | linesum | Numeerinen | 1 | Rivisumma, ei lasketa automaattisesti | 3000 |
| 3 | linedescription | Merkkijono | 0...1 | Rivikuvaus | |
| 3 | dimension | Aggregaatti | 0...n | ||
| 4 | dimensionname | Merkkijono | 1 | Laskentakohdeotsikko | Projekti |
| 4 | dimensionitem | Merkkijono | 1 | Laskentakohde | Palkanmaksu |
*1) Palkansaaja pitää olla perustettuna Netvisoriin ja palkaasaajalla täytyy olla määritetty palkkamalli.
*2) Jos jaksoa ei löydy järjestelmästä, se perustetaan, jos kyseessä on palkkamallin ensimmäinen jakso tai se alkaa heti edellisen jakson jälkeen.
Esimerkkiviesti
Palkkajaksokohtainen kirjausrivin tuonti
Resurssi: payrollperiodcollector.nv
Hakee palkansaajan palkkamallin mukaisen avoimen palkkajakson annetun päivämäärän perusteella ja lisää palkkajaksokohtaiset kirjausrivit. Asettaa laskentakohteet ja luo ne tarvittaessa.
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | Root | Aggregaatti | 1 | ||
| 1 | payrollperiodcollector | Aggregaatti | 1 | ||
| 2 | date | Päivämäärä | 1 | Päivämäärä, jolle palkansaajan palkkamallin mukainen avoin palkkajakso osuu | |
| Attribuutti | format | Merkkijono | 1 | Aina ansi | |
| 2 | employeeidentifier | Merkkijono | 1 |
Palkansaajan tunnus. Palkansaaja, jolle kirjausrivit luodaan |
|
| Attribuutti | type | Merkkijono | 0...1 | Joko "number" tai "personalidentificationnumber", eli palkansaajan numero tai henkilötunnus | |
| 2 | payrollratioline | Aggregaatti | 1...n | ||
| 3 | amount | Numeerinen | 1 | Palkkajaksokohtaisen kirjausrivin määrä/summa | |
| 3 | payrollratio | Numeerinen | 1 | Palkkalajin numero. Numero on oltava syötettynä palkkalajilla | |
| Attribuutti | type | Merkkijono | 0...1 | Aina number | |
| 3 | dimension | Aggregaatti | 0...n | ||
| 4 | dimensionname | Merkkijono | 1 | Laskentakohdeotsikon nimi. Luodaan tarvittaessa | |
| 4 | dimensionitem | Mekkijono | 1 | Laskentakohteen nimi. Luodaan tarvittaessa | |
| Attribuutti | fatherid | 0...1 | Laskentakohteen "vanhemman" (parent) tunnus |
Resurssi: payrolladvance.nv
Palkkaennakon maksun tuonti
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | Root | Aggregaatti | 1 | ||
| 1 | payrolladvance | Aggregaatti | 1 | ||
| 2 | description | Merkkijono | 0...1 | Tapahtuman kuvaus. Vapaamuotoinen selite ennakon maksamisesta | |
| 2 | employeeidentifier | Merkkijono | 1 | Palkansaajan tunnus, kenelle ennakkoa maksetaan | |
| Attribuutti | type | Merkkijono | 0...1 | Joko number tai finnishpersonalidentifier, eli palkansaajan numero tai suomalainen hetu | |
| 2 | paymentdate | Päivämäärä | 1 | Päivämäärä, jolloin ennakko lähtee maksuun. Ei voi olla kuluvaa päivää aikaisempi | |
| Attribuutti | format | Merkkijono | 0 | Aina ansi (Huom! DTDssä virhe, jos attribuutti lisätään, aiheuttaa virheen) | |
| 2 | advancesum | Numeerinen | 1 | Palkkaennakon määrä | |
| Attribuutti | paymentstatus | Merkkijono | 0...1 |
ispaid tai notpaid Palkkaennakko, joka on maksettu/merkitty maksetuksi päivittyy automaattisesti ao. palkansaajan seuraavalle palkkalaskelmalle ja vähentää maksettavaa summaa. Käyttäjän ei tarvitse huolehtia palkkaennakon vähentämisestä palkkalaskelmalta. Matkaennakko, joka on maksettu/merkitty maksetuksi päivittyy automaattisesti maksatusnäkymään (HRM > Työaika ja matkalaskut > Maksatus) ao. palkansaajan tietoihin. Maksatusnäkymässä matkaennakko voidaan kohdistaa tulevalle tai tuleville matkalaskuille. |
|
| 2 | paymenttype | Merkkijono | 1 | payroll tai tripexpence, eli palkkaennakko tai matkaennakko |
Ulkoisen palkanmaksuaineiston tuonti
Resurssi: payrollexternalsalarypayment.nv
Käytetään ulkoisen palkanmaksuaineiston tuontiin. Ei tarvitse tuoda koko palkkalaskelmaa, vaan ainoastaan maksuaineisto. Aineiston ei tarvitse linkittyä Netvisorista löytyvään palkansaajaan. Maksu tapahtuu Netvisorista, resurssi siis hyvin vastaava kuin tilisiirron tuonti.
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | Root | Aggregaatti | 1 | ||
| 1 | payrollexternalsalarypayment | Aggregaatti | 1 | ||
| 2 | description | Merkkijono | 1 | Tapahtuman kuvaus. Vapaamuotoinen selite |
Ulkoinen maksu |
| 2 | paymentdate | Päivämäärä | 1 | Maksupäivä = palkkapäivä, palkanmaksu on silloin palkansaajan tilillä | 2017-01-01 |
| Attribuutti | format | Merkkijono | ansi | ansi | |
| 2 | duedate | Päivämäärä | 1 | Eräpäivä, palkka veloitetaan yrityksen tililtä | 2017-01-01 |
| Attribuutti | format | Merkkijono | ansi | ansi | |
| 2 | externalpaymentsum | Desimaaliluku | 1 | Maksun määrä (0.01 < sum < 10000000.0) | 100,0 |
| 2 | iban | Merkkijono | 1 | Palkansaajan pankkiyhteys eli pankkitilinumero | FI21 1234 xxxx xxxx xx |
| 2 | bicc | Merkkijono | 1 | Pankin tunniste | NDEAFIHH |
| 2 | hetu | Merkkijono | 1 | Suomalainen henkilötunnus |
140785-xxyy |
| 2 | realname | Merkkijono | 1 | Palkansaajan nimi |
Erkki Esimerkki |
Annetaan jompi kumpi paymentdate tai duedate
Elementtien (paymentdate, duedate) terminologia on SEPA-tilisiirtostandardin mukainen:
SEPA Palkat Tiedote Tammikuu 2009
Maksupäivän sijasta maksutoimeksiannolla annetaan maksajan tilin veloituspäivä, jonka perusteella pankit huolehtivat että palkat ja eläkkeet ovat saajien tileillä kaikissa Suomessa toimivissa pankeissa palkkapäivänä. Tämän eräpäivän tulee olla pankkipäivä ja sen on oltavan palkkapäivää edeltävä pankkipäivä.
Eräpäivänä (duedate) palkka veloitetaan yrityksen tililtä.
Eräpäivään lisätään yksi pankkipäivä, jotta saadaan maksupäivä = palkkapäivä. Jos eräpäivä esim. perjantai lisätään 3 päivää jolloin eräpäiväksi tulee maanantai.
Maksupäivä (paymentdate) = palkkapäivä, palkanmaksu on silloin palkansaajan tilillä.
Ei tehdä pankkipäivien tulkintaa tässä vaiheessa, ne tulkitaan maksatuksessa.