Service break for the Incomes Register's stakeholder testing environment on 18 December, 4 pm – 11 December, 8 am.

Data users: this is how you can subscribe to a transcript or record

As a data user, you can place a subscription for records of 300 series or transcripts of 700 series.

The transcript or the record is generated in the language that has been specified as the service language of the organisation in the Business Information System (Finnish, Swedish or English).

Read more about transcripts or records

1

General information

The subscriber’s information is imported into the subscription from the Incomes Register’s customer data.

2

Subscription details

Enter the query date and time for the subscription.

The subscription will be queried according to the selected date and time. By default, the current date and time have been set for the query.

You can also enter the subscriber’s reference to identify the subscription.

The allowed characters for the reference are the numerals 0–9, the letters a–z and A–Z, and the special characters “_” and “-”. The reference may not contain spaces.

If you do not enter any reference, the Incomes Register will generate it for you. The format of the reference generated by the Incomes Register is IR-202X-XX.

3

Subscribed records

Add a subscribed record by selecting Add record. Select the record from the drop-down menu.

You can subscribe to several records using a single subscription. However, the records you have selected determine what other records you can add to the same subscription. The Incomes Register recommends that only one record be selected for a single subscription.

Read more about transcripts or records

Select the data access profile

The record will only include the data, which you have the right to access based on the data user’s profile.

Select what report versions are selected for the record.

Query all report versions: The record will include all report versions: new, replacement and cancelled reports.

Query only the latest report version: The record will only include the latest report version: new, replacement or cancelled report.

Select the time range, over which you want information to be added to the transcript or record.

The maximum length of the time range depends on the subscribed transcript or record.

Define one of the different time ranges or the query time range for changes as the query parameter. The time range only applies to this record, while the query time range for changes applies to the entire subscription.

    • Time range of payment date: The record or transcript will include reports, whose payment date or other report date is within the given time range.
    • Time range of reporting period: The record or transcript will include data over the given time range.
    • Query time range for changes: If you enter the query time range for changes, all records in your subscription will be queried over the same time range. The record will include reports, which have been saved in the Incomes Register or which have been corrected or cancelled during this time range. If you do not enter any end date, reports will be queried until the query date.

You can also limit the record content by using other query criteria. The range of query criteria depends on the subscribed record or transcript. Some query criteria are mandatory and some are voluntary.

Query criterion: no substitute payer’s reports

    • No selection: This is the default selection. If you do not want to filter the query, do not change this selection.
    • No reports where the payer is a substitute payer: The record will only include the reports with no substitute payer.

Incomes Register report reference

You can enter at most 200 Incomes Register report references as query criteria. The Incomes Register report reference is a technical system reference in GUID format (e.g. 40c5d83b-b2f6-4f4c-8f95-51f9224c7388). The record will include the reports that include any of the Incomes Register report references you have defined as the query criterion.

User ID

You can filter the query by entering the customer identifier of a specific individual, e.g. a personal identity code. The transcript will only include data about the specific individual’s actions in the e-service.

4

Preview

Preview the data you have entered. Finally, select Submit.

    • If any subscription details are missing or there are errors, return to previous stage to add missing details or correct the errors. Finally, select Submit.
    • You will receive an acknowledgement of receipt after your subscription has been saved successfully in the Incomes Register.

Your subscription will shortly be displayed on the Subscriptions made page in the e-service. You can monitor the progress of your subscription on the page.

    • Generating the requested transcript can take a few minutes.
    • Once the subscription has been completed, you can download the transcript on the page 'Subscriptions made'.  The 700 series records are transcripts.
    • If you requested a record to be retrieved through API (300 series), you can retrieve the record from your organisation’s SFTP folder.
Page last updated 9/30/2024