Documentation 2020

Incomes Register's interface descriptions and application guidelines for the submission and distribution of earnings and benefits payment data.

Technical documentation and document updates will be translated into English. The translations will be added when they are ready.

Data content application guidelines

Wages

  1. Descriptions of income types and items deducted from income  2020 (pdf), 21 April 2020, version 1.01

    The document contains descriptions of income types and deductibles used in the earnings payment report.
    • The document describes the situations in which the income types are used.

    • The document also contains description of withholding tax and payment of social insurance premiums with respect to each income type.

Technical interface descriptions

General descriptions

  1. Technical interface – Submitting data to the Incomes Register 2020 (pdf), 6 November 2019, version 1.0

    • This document provides an overview of how data is submitted to the Incomes Register via the technical interface. The document presents the Incomes Register’s data reception services and a general description of the data content to be submitted to the register.

  2. Technical interface – Distribution of data from the Incomes Register 2020 (pdf), 21 April 2020, version 1.02

    • This document provides an overview of the distribution of data from the Incomes Register via the technical interface. The document presents the Incomes Register’s data reception services and a general description of the data content to be distributed from the register.

  3. Income data – Calculation rules (pdf),  19 February 2019, version 1.04

Content descriptions of schemas

  1. Data delivery – Schemas – Earnings payment reports 2020 (pdf), 21 April 2020, version 1.02

    • This document presents the WageReportsToIR schema, which is used for submitting earnings payment reports to the Incomes Register.

  2. Data delivery – Schemas – Employer's separate reports 2020 (pdf), 6 November 2019, version 1.01

    • This document presents the PayerSummaryReportsToIR schema, which is used for submitting employer´s separate reports to the Incomes Register

  3. Data delivery – Schemas – Record subscriptions 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the SubscriptionsToIR schema, which is used for submitting record subscriptions to the Incomes Register.

  4. Data delivery – Schemas – Messages 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the MessagesToIR schema, by which messages are delivered to the Incomes Register.

  5. Data delivery – Schemas – Cancellation data 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the InvalidationsToIR schema, which is used for cancelling earnings reports, record subscriptions and records from the Incomes Register.

  6. Data delivery – Schemas – Acknowledgement of receipt 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the AckFromIR schema, which the Incomes Register uses to delivers an acknowledgement of receipt for the record submitted to the register (deferred Web Service interface).

  7. Data delivery – Schemas – Request for processing feedback 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the StatusRequestToIR schema, by which the record submitter can submit a request for processing feedback to the Incomes Register concerning the submitted record (deferred Web Service interface).

  8. Data delivery – Schemas – Processing feedback 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the StatusResponseFromIR schema, by which the Incomes Register delivers a processing feedback to record submitted to the register.

  9. Data distribution – Schemas – Service Request 2020 (pdf), 21 April 2020, version 1.02

    • This document presents the DataRequestToIR schema, which is used for submitting a service request for data distribution (real-time Web Service interface).

  10. Data distribution – Schemas – Earnings payment reports 2020 (pdf), 27 June 2019, version 1.0

    • This document presents the WageReportsFromIR schema, which is used to distribute earnings payment reports from the Incomes Register.

  11. Data distribution – Schemas – Employer's separate reports 2020 (pdf), 21 April 2020, version 1.01

    • This document presents the PayerSummaryReportsFromIR schema, by which employer´s separate reports are distributed from the Incomes Register.

  12. Data distribution – Schemas – Messages 2020 (pdf), 6 November 2019, version 1.0

    • This document presents the MessagesFromIR schema, by which messages are distributed from the Incomes Register.

  13. Data distribution – Schemas – Log Data 2020 (pdf), 21 April 2020, version 1.01

    • This document presents the LogDataFromIR schema, by which log data are distributed from the Incomes Register.

  14. Data distribution – Schemas – Summary of payer's earnings payment data 2020 (pdf), 21 April 2020, version 1.01
    • This document presents the WageReportSummaryFromIR schema, by which the summary data of payer's earnings payment reports is distributed from the Incomes Register.

Codes

  1. Codes 2020 (pdf), 30 January 2020, version 1.03
    • Codes used in the technical interface of the Incomes Register. The codes for the income types are presented in a separate document.
    • Codes 2020 (xls), 30 January 2020, version 1.03

  2. Wages – Codes – Income types 2020 (pdf), 27 June 2019, version 1.0
    • Codes for income types and deductibles on earnings payment reports, reporting modes and social insurance premiums used as default in the income types.
    • Wages - Codes - Income types 2020 (xls), 27 June 2019, version 1.0 

  3. Codes - Error codes 2020 (xls), 13.8.2020, version 1.05
  4. Codes – Classification of Occupations (18.5.2018)
    • Classification of Occupations maintained by Statistics Finland and used in the Incomes Register is available on the Statistics Finland website in section Incomes Register.

Application developer's guidelines

  1. Technical interface – Application guidelines 2020 (pdf),  21 April 2020, version 1.01

    • This document describes the principles of the implementation of the Incomes Register technical interface from the system integration perspective

  2. Technical interface – ZIP file for application developers 2020 (zip), 21 April 2020, version 1.16
    • A ZIP file that contains xsd descriptions and WSDL descriptions of services.

  3. Technical interface – ZIP file for application developers (pdf) 2020, 21 April 2020, version 1.01

    • This document presents the ZIP-file’s contents.