The Incomes Register's technical instructions and schema descriptions for software developers for 2020 will be published on this page. More content will be added on the page in autumn 2019.

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

Will be published later.

Benefits

Will be published later.

Technical interface descriptions

General descriptions

  1. Technical interface – Submitting data to the Incomes Register (pdf), 11 June 2018, version 1.04

    • 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 (pdf), 7 January 2019, version 1.07

    • 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), 27 June 2019, version 1.0

    • 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), 27 June 2019, version 1.0

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

  3. Data delivery – Schemas – Benefits payment reports (pdf), 24 June 2019, version 1.04

    • This document presents the BenefitReportsToIR schema used for submitting benefits payment reports to the Incomes Register.
  4. Data delivery – Schemas – Record subscriptions (pdf), 7 January 2019, version 1.07

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

  5. Data delivery – Schemas – Messages (pdf), 26 September 2018, version 1.05

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

  6. Data delivery – Schemas – Cancellation data (pdf), 26 September 2018, version 1.05

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

  7. Data delivery – Schemas – Acknowledgement of receipt (pdf), 26 September 2018, version 1.04

    • 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).

  8. Data delivery – Schemas – Request for processing feedback (pdf), 26 September 2018, version 1.05

    • 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).

  9. Data delivery – Schemas – Processing feedback (pdf), 26 September 2018, version 1.04

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

  10. Data distribution – Schemas – Service Request (pdf), 7 January 2019, version 1.06

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

  11. 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.

  12. Data distribution – Schemas – Employer's separate reports (pdf), 26 September 2018, version 1.05

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

  13. Data distribution – Schemas – Benefits payment reports (pdf), 8 March 2019, version 1.02

    • This document presents the BenefitReportsFromIR schema, by which benefits payment reports are distributed from the Incomes Register.
  14. Data distribution – Schemas – Messages (pdf), 26 September 2018, version 1.04

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

  15. Data distribution – Schemas – Log Data (pdf), 26 September 2018, version 1.04

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

  16. Data distribution – Schemas – Summary of payer's earnings payment data (pdf), 26 September 2018, version 1.02
    • 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),  27 June 2019, version 1.0
    • 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), 27 June 2019, version 1.0
  2. 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.
    • Codes - Income types 2020 (xls), 27 June 2019, version 1.0 
  3. Codes - Error codes (xls), 11 June 2019, version 1.09
  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 – ZIP file for application developers, 27 June 2019, version 1.0

    • A ZIP file that contains xsd descriptions, examples of the structure of schemas, and WSDL descriptions of services.

  2. Technical interface – ZIP file for application developers (pdf), 27 June 2019, version 1.0

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