Skip to the content
  • The testing instructions for the information service

    Municipalities can submit test material to the financial information service for municipalities.

    The financial information transfer service can receive test data in both XBRL and CSV formats. The amount of material does not need to be great, and the material itself need not be real. It could include a municipality’s balance sheet, profit and loss account or financial statement, for example.

    The link contains detailed instructions for testers >

    After sending your material, you can view it in the approval service and verify that the test transfer was successful.

    More details on XBRL and XBRL taxonomy are available under the heading XBRL in the Ohjeet (‘Instructions’) tab.

  • Submitting the test files via the website

    Currently, XBRL instance documents that comply with the taxonomies of municipal finances or CSV files that the service can use to create the necessary XBRL instance documents may be submitted to the financial information services for municipalities.

    The site for uploading the material: https://sipaapigw.azure-api.net/usertest/index.html

    User ID: Enter the sender’s email address in the field. Its form will not be verified.

    Password: Currently (15 September 2017), the password will not be verified, but this information must still be entered.

    Material: The file to be sent.

    Type of material: The type of material to be sent.

  • Submitting the test material via the interface

    Test material that is in XBRL or CSV format can be sent via the REST interface

    The interface is located at https://sipaapigw.azure-api.net/usertest/uploadMaterialFile.

    However, the interface may be moved to another location. You can check the correct address from the State Treasury by sending an email to analysointipalvelu(at)valtiokonttori.fi, or from CSC by sending email to kuntatalous(at)postit.csc.fi.

    The description of the REST interface and the related instructions:

    REST-interface {BASE_URL}/uploadMaterialFile, which listens for POST multipart/form-data requests. Expects following parameters:

    Parameter name

    Meaning

    Possible values

    Notes

    user User who is sending material In a testing environment this could be an email address, for example
    fileType Type of material XBRL | CSV
    processType TEST | SUBMISSION

     

    Parameter name

    Meaning

    Possible values

    Notes

    file the uploaded file File size must be greater than 0, otherwise it is not validated

    After successful completion returns http-code 200 with json

    {”reason”:null,”response”:”OK”,”uuid”:”22596774-415e-409f-82d1-210dd666b2c3″,”erroneous”:false}

    If mandatory parameter is missing, returns http-code 400 with json explaining missing parameter

    {”timestamp”:1505373269570,”status”:400,”error”:”Bad Request”,”exception”:”org.springframework.web.bind.MissingServletRequestParameterException”,”message”:”Required String parameter ’processType’ is not present”,”path”:”/uploadMaterialFile”}

    If invalid parameters were given, returns http-code 400 with json explaining invalid parameter

    {”reason”:”No enum constant fi.csc.sipa.common.model.metadata.ProcessType.TESTI”,”response”:null,”uuid”:null,”erroneous”:true}

    If file size is exceeded returns http-code 413 with json

    {”errorCode”:413,”reason”:”Liian suuri tiedosto”}

    If there are problems with the backend services returns http-code 500 with json explaining reason

    {”reason”:null,”response”:”FILE_CANNOT_BE_ADDED”,”uuid”:”d1ae3ac2-9600-408b-a63e-b2c41351896e”,”erroneous”:true}

  • Sending municipalities’ financial data via the Suomi.fi test service channel

    Basic information about the role of Suomi.fi https://esuomi.fi/palveluntarjoajille/palveluvayla/sanasto (in Finnish)

    The sending is typically done with software that performs the http sending (HTTP POST). The material is sent to the sender’s own API server, which passes it on to the financial information service for municipalities via the service channel.

    Below is the message template (changing sections have been highlighted in red).

    <soapenv:Envelope

    target=”_blank” rel=”noopener”>http://schemas.xmlsoap.org/soap/envelope/

    target=”_blank” rel=”noopener”>http://kuntadata.fi/schemas/talousilmoitus

    target=”_blank” rel=”noopener”>http://x-road.eu/xsd/identifiers

    target=”_blank” rel=”noopener”>http://x-road.eu/xsd/xroad.xsd>

    <soapenv:Header>
    <xrd:client id:objectType=”SUBSYSTEM”>
    <id:xRoadInstance>FI-TEST</id:xRoadInstance>
    <id:memberClass>GOV</id:memberClass>
    <id:memberCode>1234567-1</id:memberCode>
    <id:subsystemCode>Alijärjestelmä</id:subsystemCode>
    </xrd:client>
    <xrd:service id:objectType=”SERVICE”>
    <id:xRoadInstance>FI-TEST</id:xRoadInstance>
    <id:memberClass>GOV</id:memberClass>
    <id:memberCode>0920632-0</id:memberCode>
    <id:subsystemCode>Kuntatalouden tietopalvelu</id:subsystemCode>
    <id:serviceCode>uploadMaterialFile</id:serviceCode>
    <id:serviceVersion>v1</id:serviceVersion>
    </xrd:service>
    <xrd:userId>mvirtanen</xrd:userId>
    <xrd:id>30b3b389-892a-469a-b2da-f7dd98594e53</xrd:id>
    <xrd:protocolVersion>4.0</xrd:protocolVersion>
    </soapenv:Header>
    <soapenv:Body>
    <fi:uploadMaterialFileRequest>
    <fi:fileType>XBRL</fi:fileType>
    <fi:processType>TEST</fi:processType>
    <fi:filename>aineisto.xbrl</fi:filename>
    <fi:file><!– Base 64 -koodattu aineisto –></fi:file>
    </fi:uploadMaterialFileRequest>
    </soapenv:Body>
    </soapenv:Envelope>

    envelope Standard SOAP message
    client Sender’s information
    service Receiver’s, i.e. the information service’s, information. The service will be registered before the launch of the municipal pilot, and this information will change.
    xrd:userId user ID
    xrd:id Message identifier, e.g. a generated UUID
    body Message content. A WSDL template exists for this. The information is the same as on the online sending page.

     

  • Submitting financial material on municipalities using the Suomi.fi interface (updated on 8 October 2018)

    Basic information about the role of Suomi.fi https://esuomi.fi/palveluntarjoajille/palveluvayla/sanasto (in Finnish)

    The API catalogue lists the APIs of Suomi.fi: https://liityntakatalogi.suomi.fi/en_GB/

    Select State Treasury as the organisation.

    API catalogue

    The service can be browsed after registration and contains the WSDL template.

    The API catalogue contains an example of the information that can be found there in the future.

    https://liityntakatalogi.suomi.fi/en_GB/dataset/kirjastokeski

    Material is typically sent with software that performs the http sending (HTTP POST).

    The script template can be found below.

    Script template.

    envelope Standard SOAP message.
    client Sender’s information.
    service Receiver’s, i.e. the information service’s, information. A picture of the test version. The service will be registered before the launch of the municipal pilot, and this information will change.
    userid User ID
    body Message content. A WSDL template exists for this. The information is the same as on the online sending page.

     

  • Service Description Language file

    The link leads to the interface description file.

    After sending your material, you can view it in the approval service and verify that the test transfer was successful.

    Approved information that has been transferred to the register service can be accessed via the interface.

    Instructions on testing the interface (pdf) > (in Finnish)

    Instructions for the information service testers (pdf) >

    A template file for senders of CSV material

    A budget and financial plan CSV (txt) > (in Finnish)

    Further information:kuntadata@valtiokonttori.fi