Verkkopalkka-rajapintakuvaus

Transkriptio

1 PAYSLIPXML v.1.1 Verkkopalkka-rajapintakuvaus sivu 1/12

2 Sisällysluettelo 1 Yleistä Payslip-scheeman kuvaus Xml-tiedosto HeaderData ControlData PayPeriod Delivery Employee Classification BankAccount CalculationBases PayDetails EarningsToDate Messages sivu 2/12

3 PAYSLIPXML Verkkopalkka-rajapintakuvaus 1 Yleistä PAYSLIPXML on verkkopalkkaoperaattoreiden kehittämä ja ylläpitämä kuvaus, jota kansallisessa verkkopalkkakonseptissa mukana olevat operaattori ovat sitoutuneet käyttämään. Palkanmaksaja toimittaa palkkalaskelmat tämän sanomakuvauksen mukaisessa muodossa Tiedon verkkopalkkapalveluun. Lisätietoja: sivu 3/12

4 2 Payslip-scheeman kuvaus Kuvassa 1 on Payslip-scheeman yleiset tietoryhmät ja niiden esiintymisjärjestys. Kuvassa 2 on esitetty tarkemmin HeaderData-osion pakolliset tunnistetiedot. Kuva 1. Xml-ansiolaskelman yleinen rakenne. sivu 4/12

5 Kuva2. Xml-ansiolaskelman tunnistetietojen lohko. 3 Xml-tiedosto Vaikka xml-laskelmadokumentti voi koostua yhdestä ainoasta rivistä, ohjelmointisuositus on rivittää xml-tiedostot seuraavasti: Yksittäiset avainsanat (tagit) omalle riville. Data sitä ja ympäröivät alku- ja lopputagit samalle riville. Vältetään rivien sisennystä. Suosituksen tarkoituksena on helpottaa mm. tietohuoltoa. Seuraavissa xml-ansiolaskelman osioiden kuvauksissa esitetään osioiden ja niiden elementtien tarkoitusta ja sisältöä. Ensimmäinen HeaderData-osio ja sen elementit ovat pakollisia, koska osion tiedoilla ohjataan ansiolaskelmien arkistointia ja käsittelyä esilläpitopalvelussa. Osioiden elementit ovat vapaaehtoisia (optionaalisia). Mahdollinen elementin nimen perässä oleva tarkennusmerkki tarkoittaa: * elementti voi esiintyä 0..n kertaa + elementti voi esiintyä 1..n kertaa sivu 5/12

6 4 HeaderData Pakollinen HeaderData-osio sisältää ansiolaskelmien esilläpitopalvelun vaatimat avain- ja hallintatiedot. PersonID PPKKVV-999X Muotoiltu henkilötunnus PayDate VVVVKKPP Maksupäivämäärä NetPayment X(1..12) Maksettava nettoansio editoituna Payer X(1..30) Maksajan nimi PayslipOnPaper X(1) Onko myös paperilaskelma: K/E, Y/N, * StylesheetID X(1..20) XSL-tyylisivun tunnus LangCode X(1..2) Ansiolaskelman sisällön kielikoodi: BusinessID ReceivingBank tai tai FI (suomi), 2 tai SV (ruotsi) 3 tai EN (englanti) Maksajan Y-tunnus editoituna BankCode 9(6) Pankkiryhmätunnus 1 * (pakollinen) BankCode 9(6) Pankkiryhmätunnus 2 * (voi puuttua!) Käyttäjälle näytettävä maksettava nettoansio (NetPayment) muotoillaan palkkajärjestelmässä ja se näytetään sellaisenaan käyttöliittymässä. Pankkiryhmän tunnus (BankCode) on palkansaajan pankkitilinumeron kuusi ensimmäistä numeroa. sivu 6/12

7 5 ControlData ControlData-osio sisältää ansiolaskelman yleisiä tunnistetietoja. Company Maksajan tietoja ansiolaskelmalla BusinessID X(9) Y-tunnus Name* X(*) Yrityksen nimi tekstimuotoinen Logo Language Ansiolaskelman kieliasu LanguageID X(1..2) Kielikoodi: 1=fi, 2=sv 3=en Name X(*) Kielen nimi Title* Ansiolaskelman tunnistetietoja Heading* X(*) Seliteteksti 6 PayPeriod PayPeriod-osio sisältää palkanmaksukauden tunnistetietoja. DateOfPayment Maksupäivätietoja Date X(*) Päivämäärä Period Palkkakauden tietoja PeriodCode X(*) Palkkakauden tunnus PeriodDates* Palkkakauden kesto StartDate Palkkakauden alkamispäivämäärä Date X(*) Päivämäärä TermDate Palkkakauden päättymispäivämäärä Date X(*) Päivämäärä sivu 7/12

8 7 Delivery Delivery-osio sisältää ansiolaskelman lähettäjän ja vastaanottajan osoitetietoja. Sender Lähettäjän postiosoitetietoja Heading X(*) Seliteteksti PostalAddress Lähettäjän osoite PersonLine* X(*) Nimi AddressLine* X(*) Osoite PostalCode X(*) Postitoimipaikka Country X(*) Maa Recipient Vastaanottajan postiosoitetietoja Heading X(*) Seliteteksti PostalAddress Vastaanottajan osoite PersonLine* X(*) Nimi AddressLine* X(*) Osoite PostalCode X(*) Postitoimipaikka Country X(*) Maa Postage Postitussopimustietoja Heading X(*) Seliteteksti Category Postiluokka Label X(*) Seliteteksti Contract Postin jakelusopimustietoja Label X(*) Seliteteksti sivu 8/12

9 8 Employee Employee-osio sisältää palkansaajan tunnistetietoja. Identity Henkilötunnus Label X(*) Seliteteksti PersonID PPKKVV-999X Henkilötunnus PersonNumber Henkilönumero PersonName X(*) allekirjoitus (ei henkilötunnusta!) EmploymentDate SalaryCategory* Työsuhteen aikatietoja Palkkausperustetieto 9 Classification Classification-osio sisältää henkilön tehtävätietoja. JobTitle Tehtävänimike DeptCode Organisaatiotunnus CostFollowUp* Kustannnuspaikka sivu 9/12

10 10 BankAccount BankAccount-osio sisältää palkanmaksun pankkiyhteystietoja. Accountcode* Pankkitili Value X(*) Selitearvo 11 CalculationBases CalculateBases-osio sisältää palkanlaskennan perustetietoja. SalaryRates* Maksuperuste Heading* Maksuperusteen selitys Record* Peruste Label* X(*) Perusteteksti Value* X(*) Perustearvo TaxationRates* Verotusperuste Heading* Verotusperusteen selitys Record* Peruste Label* X(*) Perusteteksti Value* X(*) Perustearvo DeductionRates* Heading* Record* Vähennysperuste Vähennysperusteen selitys Peruste Label* X(*) Perusteteksti Value* X(*) Perustearvo VacationRecords* Heading* Lomaperuste Lomaperusteen selitys Record* Peruste Label* X(*) Perusteteksti Value* X(*) Perustearvo sivu 10/12

11 12 PayDetails PayDetails-osio sisältää maksetun palkan erittelytietoja. DetailList HeadingLine Ansioerittely Erittelyn sarakeotsikot Heading* Otsikkoteksti DetailLine* Erittelyrivi PayCode X(*) Palkkakoodi tai laji Description* X(*) Seliteteksti(t) Hours X(*) Tuntien/päivien määrä HourlyRate X(*) Tunti/päiväpalkka Units X(*) Kappalemäärä UnitRate X(*) Kappalehinta Amount X(*) Ansiomäärä Date* X(*) Tapahtuma-aika 13 EarningsToDate Kukin EarningsToDate-osio sisältää summattuja ansio- tai vähennystietoja joltain aikajaksolta esim. palkkakauden alusta, verovuoden alusta, edellinen vuosi. Set* SetHeading* Heading* X(*) Otsikkoteksti Line* Summataulukon sarake tai rivi Sarakkeen tai rivin otsikko Summataulukon rivi tai sarake LineHeading* X(*) Rivin tai sarakkeen otsikkoteksti Cell* Summataulukon lokero Summatiedot voidaan esittää ansiolaskelmalla taulukkomuodossa ja edellä kuvatun rakenteen tarkoitus on mahdollistaa tietojen talletus joko riveittäin tai sarakkeittain. sivu 11/12

12 14 Messages Messages-osio sisältää ansiolaskelmalla näytettäviä tiedotteita. Permanent* Kaikille tulostuva teksti Label* X(*) Viestiselite Value* X(*) Viestiteksti Transient* Valikoidusti tulostettu teksti Label* X(*) Viestiselite Value* X(*) Viestiteksti sivu 12/12