Dokumentaatio

Tulorekisterin palkka- ja etuustietojen toimittamiseen ja jakeluun liittyvät rajapintakuvaukset ja niihin liittyvät soveltamisohjeet.

 

Tietosisällön soveltamisohjeet

Palkat

1. Tietojen ilmoittaminen tulorekisteriin (16.4.2018, versio 1.04)

   • Dokumentti on yleisesitys tietojen ilmoittamisesta tulorekisteriin

   • Dokumentissa kuvataan rahapalkkojen ja sosiaalivakuutusmaksujen ilmoittaminen ja annettujen tietojen korjaaminen esimerkkien avulla

2. Tulolajien ja tuloista vähennettävien erien selitteet (1.10.2018, versio 1.07)

   • Palkkatietoilmoituksella olevien tulolajien ja tuloista vähennettävien erien selitteet

   • Dokumentissa kuvataan tilanteet, joissa tulolajeja käytetään

   • Lisäksi kuvataan ennakonpidätyksen toimittaminen ja sosiaalivakuutusmaksujen maksaminen kunkin tulolajin osalta

3. Palkkatietoilmoituksen tietosisällön soveltamisohje (1.10.2018, versio 1.06)

   • Dokumentissa kuvataan palkkatietoilmoituksen tietosisältö ja mitä tietosisällön kussakin yksittäisessä kohdassa ilmoitetaan

4. Työnantajan erillisilmoituksen soveltamisohje (1.10.2018, versio 1.02)

   • Dokumentissa kuvataan työnantajan erillisilmoituksen tietosisältö ja mitä tietosisällön kussakin yksittäisessä kohdassa ilmoitetaan

Etuudet

1. Etuudet – Tietojen ilmoittaminen tulorekisteriin (13.6.2018, versio 1.00)

   • Dokumentti on yleisesitys etuustietojen ilmoittamisesta tulorekisteriin.

   • Dokumentissa kuvataan esimerkkien avulla yleisimpiä tulorekisterin etuustietojen ilmoitustilanteita.
2. Etuudet – Tulolajien ja tuloista vähennettävien erien selitteet (26.9.2018, versio 1.01)

   • Etuustietoilmoituksella olevien tulolajien ja tuloista vähennettävien erien selitteet.

   • Dokumentissa kuvataan tilanteet, joissa tulolajeja käytetään.

3. Etuustietoilmoituksen tietosisällön soveltamisohje (26.9.2018, versio 1.01)

   • Dokumentissa kuvataan etuustietoilmoituksen tietosisältö ja mitä tietosisällön kussakin yksittäisessä kohdassa ilmoitetaan.

Teknisen rajapinnan kuvaukset

Yleiskuvaukset

1. Tekninen rajapinta - Tietojen toimittaminen tulorekisteriin (11.6.2018, versio 1.04)

   • Dokumentti on yleiskuvaus tietojen toimittamisesta tulorekisteriin teknisen rajapinnan kautta. Dokumentissa esitellään tulorekisteriin tietoa vastaanottavat palvelut ja tulorekisteriin toimitettava tietosisältö yleisellä tasolla.

2. Tekninen rajapinta – Tietojen jakelu tulorekisteristä (26.9.2018, versio 1.06)

   • Dokumentti on yleiskuvaus tietojen jakelusta tulorekisteristä teknisen rajapinnan kautta. Dokumentissa esitellään tulorekisteristä tietoa jakavat palvelut ja tulorekisteristä toimitettava tietosisältö yleisellä tasolla.

3. Tulotiedot - Laskentasääntöjä (26.9.2018, versio 1.02)

4. Raportit tulorekisteristä (26.9.2018, versio 1.01)

   • Dokumentissa kuvataan tulorekisteristä tuotettavat raportit tiedon tuottajille ja tiedon käyttäjille.

Skeemojen sisältökuvaukset

1. Tietojen toimittaminen - Skeemat - Palkkatietoilmoitukset (8.11.2018, versio 1.07)

   • Dokumentissa esitellään skeema WageReportsToIR, jolla palkkatietoilmoitukset toimitetaan tulorekisteriin.

2. Tietojen toimittaminen - Skeemat - Työnantajan erillisilmoitukset (26.9.2018, versio 1.05)

   • Dokumentissa esitellään skeema PayerSummaryReportsToIR, jolla työnantajan erillisilmoitukset toimitetaan tulorekisteriin.

3. Tietojen toimittaminen - Skeemat - Etuustietoilmoitukset (26.9.2018, versio 1.01)
   • Dokumentissa esitellään skeema BenefitReportsToIR, jolla etuustietoilmoitukset toimitetaan tulorekisteriin.

4. Tietojen toimittaminen - Skeemat - Aineistotilaukset (26.9.2018, versio 1.06)

   • Dokumentissa esitellään skeema SubscriptionsToIR, jolla aineistotilaukset toimitetaan tulorekisteriin.

5. Tietojen toimittaminen-Skeemat-Viestit (26.9.2018, versio 1.05)

   • Dokumentissa esitellään skeema MessagesToIR, jolla viestit toimitetaan tulorekisteriin.

6. Tietojen toimittaminen - Skeemat - Mitätöintitiedot (26.9.2018, versio 1.05)

   • Dokumentissa esitellään skeema InvalidationsToIR, jolla tulorekisteristä mitätöidään tulotietoilmoituksia, aineistotilauksia ja aineistoja.

7. Tietojen toimittaminen - Skeemat - Vastaanottokuittaus (26.9.2018, versio 1.04)

   • Dokumentissa esitellään skeema AckFromIR, jolla tulorekisteri toimittaa vastaanottokuittauksen tulorekisteriin lähetettyyn aineistoon (viivästetty Web Service -rajapinta).

8. Tietojen toimittaminen - Skeemat - Käsittelypalautteen kysely (26.9.2018, versio 1.05)

   • Dokumentissa esitellään skeema StatusRequestToIR, jolla aineiston toimittaja voi kysyä käsittelypalautetta tulorekisteriin toimitetusta aineistosta (viivästetty Web Service -rajapinta).

9. Tietojen toimittaminen - Skeemat - Käsittelypalaute (26.9.2018, versio 1.04)

   • Dokumentissa esitellään skeema StatusResponseFromIR, jolla tulorekisteri toimittaa käsittelypalautteen tulorekisteriin toimitetusta aineistosta.

10. Tietojen jakelu – Skeemat - Palvelupyyntö (26.9.2018, versio 1.05)

    • Dokumentissa esitellään skeema DataRequestToIR, jolla tietojen jakelun palvelupyyntö toimitetaan tulorekisteriin (reaaliaikainen Web Service -rajapinta).

11. Tietojen jakelu – Skeemat - Palkkatietoilmoitukset (26.9.2018, versio 1.05)

    • Dokumentissa esitellään skeema WageReportsFromIR, jolla palkkatietoilmoitukset toimitetaan tulorekisteristä.

12. Tietojen jakelu - Skeemat - Työnantajan erillisilmoitukset (26.9.2018, versio 1.05)

    • Dokumentissa esitellään skeema PayerSummaryReportsFromIR, jolla työnantajan erillisilmoitukset toimitetaan tulorekisteristä.

13. Tietojen jakelu – Skeemat – Etuustietoilmoitukset (26.9.2018, versio 1.00) 

    • Dokumentissa esitellään skeema BenefitReportsFromIR, jolla etuustietoilmoitukset toimitetaan tulorekisteristä..

15. Tietojen jakelu - Skeemat - Viestit (26.9.2018, versio 1.04)

    • Dokumentissa esitellään skeema MessagesFromIR, jolla viestit toimitetaan tulorekisteristä.

16. Tietojen jakelu - Skeemat - Lokitiedot (26.9.2018, versio 1.04)

    • Dokumentissa esitellään skeema LogDataFromIR, jolla lokitiedot toimitetaan tulorekisteristä.

17. Tietojen jakelu – Skeemat – Maksajan palkkatietojen yhteenveto (26.9.2018, versio 1.02)

• • Dokumentissa esitellään skeema WageReportSummaryFromIR, jolla maksajan palkkatietoilmoitusten yhteenvetotiedot toimitetaan tulorekisteristä.

Koodistot

1. Koodistot (pdf, 14.12.2018, versio 1.11)

   • Tulorekisterin teknisessä rajapinnassa käytettävät koodistot. Tulolajien koodit on esitelty erillisessä dokumentissa.

   • Koodistot (xls, 5.12.2018, versio 1.10)
     
     

2. Palkat - Koodistot – Tulolajit (pdf, 26.9.2018, versio 1.05)

   • Palkkatietoilmoituksen tulolajien ja tuloista vähennettävien erien koodit, ilmoitustavat ja tulolajeissa oletuksena olevat sosiaalivakuutusmaksut.

   • Työnantajan erillisilmoituksen tulolajien koodit.

   • Palkat - Koodistot - Tulolajit  (xls, 26.9.2018, versio 1.04)

3. Etuudet – Koodistot – Tulolajit (26.9.2018, versio 1.01)

• • Etuustietoilmoituksen tulolajien ja tuloista vähennettävien erien koodit ja ilmoitustavat.
  • Etuudet – Koodistot – Tulolajit (xls, 26.9.2018, versio 1.01)

4. Koodistot - Virhekoodit (xls, 19.11.2018, versio 1.04)

• • Virhekoodit englanniksi: Codes - Error codes  (xls, 19.11.2018, versio 1.04)

5. Koodistot - Ammattiluokitus (18.5.2018)

• • Tulorekisterissä käytettävä Tilastokeskuksen ylläpitämä ammattiluokitus on Tilastokeskuksen sivuilla kohdassa Tulorekisteri.

Sovelluskehittäjän ohjeet

1. Tekninen rajapinta – Soveltamisohje (22.10.2018, versio 1.06)

   • Dokumentissa kuvataan tulorekisterin teknisen rajapinnan toteutukseen liittyvät periaatteet järjestelmäintegraation toteuttajan näkökulmasta.

2. Tekninen rajapinta – ZIP – Sovelluskehittäjälle (4.10.2018, versio 1.09)

• ZIP-tiedosto, joka sisältää skeemojen xsd-kuvaukset, esimerkit skeemojen rakenteesta ja palvelujen WSDL-kuvaukset.

3. Tekninen rajapinta – ZIP – Sovelluskehittäjälle, PDF (4.10.2018, versio 1.09)

   • Dokumentissa esitellään ZIP-tiedoston sisältö.

Sanomaesimerkit: Tietojen toimittaminen - Palkkatietoilmoitus

Dokumenteissa on esimerkkejä palkkatietoilmoituksen toimittamiseen liittyvistä tilanteista.

1. Esimerkki 001: Sopimustyönantaja perustapaus (14.11.2017, versio 1.0)

2. Esimerkki 002: Tilapäinen työnantaja (14.11.2017, versio 1.0)

3. Esimerkki 003: Ulkomainen maksaja, ulkomainen tulonsaaja (14.11.2017, versio 1.0)

4. Esimerkki 004: Julkisyhteisö maksajana (14.11.2017, versio 1.0)

5. Esimerkki 005: Ulkomaantyö (14.11.2017, versio 1.0)

6. Esimerkki 006: Vakuuttamisen poikkeustilanne 1, ulkomainen työnantaja (14.11.2017, versio 1.0)

7. Esimerkki 007: Vakuuttamisen poikkeustilanne 2, iän perusteella (14.11.2017, versio 1.0)

8. Esimerkki 008: Tulonsaaja rajoitetusti verovelvollinen (14.11.2017, versio 1.0)

9. Esimerkki 009: Tulolajin vakuuttamistiedon tyyppi (14.11.2017, versio 1.0)

10. Esimerkki 010: Poissaolotiedot (14.11.2017, versio 1.0)

11. Esimerkki 011: Perusteeton etu, liikasuoritus ilmoitettu aiemmin muuna tulona (22.1.2018, versio 1.0)

12. Esimerkki 012: Perusteeton etu 2,  liikasuoritus huomataan ennen ilmoituksen lähettämistä (22.1.2018, versio 1.0)

13. Esimerkki 013: Takaisinperintä, bruttoperintä (22.1.2018, versio 1.0)

14. Esimerkki 014: Takaisinperintä 2, nettoperintä (22.1.2018, versio 1.0)

15. Esimerkki 015: Takaisinperintä 3, bruttoperintä, sisältää useita tulolajeja (22.1.2018, versio 1.0)

16. Esimerkki 016: Takaisinperintä 4, summa peritään takaisin kerralla (22.1.2018, versio 1.0)

17. Esimerkki 017: Kustannusten korvaukset (23.4.2018, versio 1.0)

18. Esimerkki 018: Työkorvaus, tulonsaajana luonnollinen henkilö (23.4.2018, versio 1.0)

19. Esimerkki 019: Työkorvaus, tulonsaajana yhteisö (23.4.2018, versio 1.0)

20. Sanomaesimerkit – Tietojen toimittaminen – Palkkatietoilmoitukset – ZIP (24.4.2018, versio 1.02)

• • ZIP-tiedosto, joka sisältää sanomaesimerkkeihin liittyvät xml-tiedostot. Jokaiseen esimerkkiin liittyy kaksi tiedostoa: skeema, jolla tiedot toimitetaan tulorekisteriin sekä käsittelypalaute, jonka ilmoittaja esimerkkitapauksessa saa.

Sanomaesimerkit: Tietojen toimittaminen – Aineistotilaus

Dokumenteissa on esimerkkejä aineistotilauksen toimittamiseen liittyvistä tilanteista.

1. Esimerkki 001: Palkkatietoilmoitukset – kaikki tulonsaajat, jatkuva tilaus (15.12.2017, versio 1.0)

2. Esimerkki 002: Palkkatietoilmoitukset – useita tulonsaajia 1, jatkuva tilaus (15.12.2017, versio 1.0)

3. Esimerkki 003: Palkkatietoilmoitukset – useita tulonsaajia 2, kertatilaus (8.1.2018, versio 1.01)

4. Esimerkki 004: Palkkatietoilmoitukset – useita maksajia 1, jatkuva tilaus (15.12.2017, versio 1.0)

5. Esimerkki 005: Palkkatietoilmoitukset – useita maksajia 2, kertatilaus (8.1.2018, versio 1.01)

6. Esimerkki 006: Palkkatietoilmoitukset – useita maksajia, useita tulonsaajia, jatkuva tilaus (8.1.2018, versio 1.01)

7. Esimerkki 007: Palkkatietoilmoitukset – useita aineistoja, kertatilaus (8.1.2018, versio 1.01)

8. Sanomaesimerkit – Tietojen toimittaminen – Aineistotilaus – ZIP (8.1.2018, versio 1.01)

• • ZIP-tiedosto, joka sisältää sanomaesimerkkeihin liittyvät xml-tiedostot. Jokaiseen esimerkkiin liittyy kaksi tiedostoa: skeema, jolla tiedot toimitetaan tulorekisteriin sekä käsittelypalaute, jonka ilmoittaja esimerkkitapauksessa saa.

Sanomaesimerkit – Palkkojen ilmoittaminen

Dokumentissa on esimerkki yhden yrityksen kaikista palkkatietoilmoituksista ja työnantajan erillisilmoituksista neljän kuukauden ajalta. Esimerkissä on kuusi tulonsaajaa, ja palkkatietoilmoituksilla on erilaisia työskentely- ja maksutilanteita.

1. Esimerkki: Tulonsaajat A–F, tammikuu–huhtikuu 2019 (5.3.2018, versio 1.01)

2. Sanomaesimerkit – Palkkojen ilmoittaminen – ABCDEF – ZIP (5.3.2018, versio 1.01)

• • ZIP-tiedosto, joka sisältää esimerkkiin liittyvät xml-muotoiset aineistot (27 kappaletta)

Esimerkkitoteutus sanoman allekirjoittamisesta

1. Tekninen rajapinta - ZIP- sanoman allekirjoitus, esimerkkitoteutus (23.3.2018, versio 1.0)

• • Dokumentissa esitellään ZIP-tiedoston sisältö

2. Tekninen rajapinta - ZIP - sanoman allekirjoitus, esimerkkikoodit (23.3.2018, versio 1.0)

• • ZIP-tiedosto sisältää .Net/C#-kielellä laaditun asiakasrajapinnan (client) toteutuksen Echo-palvelun (EchoService) kutsusta ja lähetettävän pyyntösanoman allekirjoittamisesta.