Enter your credentials to Maventa testing environment, to authenticate and try things out with the Swagger UI. This will fetch a Bearer token using OAuth2 with the endpoint POST https://ax-stage.maventa.com/oauth2/token. The token is stored in your browser's session storage (cleared when you close the tab) and used in Swagger calls done from this documentation website. The token is valid for 1 hour.

Never use your production credentials here. This is only for testing the Maventa test environment in the Swagger UI.
All None
eui global company lookup document:receive document:send invoice:receive invoice:send company:read company:write validate receivables:assignments analysis billing:reports partner:invoice_delivery_actions partner:lookups partner:takeovers partner:lyanthe_scan_service fi_bank_message:send fi_bank_message:receive
Cancel Sign In
Search
Debt collection and reminder services Amili Kassavirta Amili Perintä Other Mass Printing Service Detect Supplier Activation Maventa Connector Embeddable User Interface

Mass Printing Service

The Maventa Mass Printing Service, also referred to as Payslip, allows sending PDF files as physical letters through the Finnish printing service. While originally designed for distributing payslips, it can be used for sending any type of letters, provided the printing service rules are followed. This service is available only for Finnish companies.

Note: Invoices intended for print should always be sent via the standard invoice delivery channels, not through this service.

User account opening

To use the Mass printing API, you need a dedicated user account. This account can be created with an API call to https://payslip.maventa.com/register, using your existing vendor_api_key and company_uuid from Maventa. Testing endpoint https://payslip-stage.maventa.com/register.

Request for registering

Key Example Description
sw_api_key d33e92be-a46b-4963-8ada-25452712e0a6 Existing software API key from Maventa
company_uuid 99445728-5fd3-428a-96e1-ca0cab692276 Existing company uuid from Maventa
company_name Test Company Oy Name of the company
user_email test@yritys.fi User email address that will be used as user name, needs to be unique! Each account needs it’s own email address
user_pw secret1234 Password for the user
test_mode 1 1 opens the account in test mode which means that material is not really send out. Note! Contact support to disable the test mode.
0 opens the account in production mode
disable_notify_on_complete 1 0 (default) user will get an email notification when material is printed successfully.

Response for registering

The response code will always be a HTTP 200 and the response body is one of the following:

Value Description
“OK” Successful registration, letters can be send and login works
“ERROR: COMPANY UUID ALREADY REGISTERED” Registration failed, company exists already in Payslip service
“ERROR: USER EMAIL ALREADY REGISTERED” Registration failed, user email exists already in Payslip service
“ERROR: ONLY FINNISH COMPANIES ALLOWED” Only Finnish companies allowed to register
“ERROR: USER EMAIL INVALID” Invalid email address
“ERROR: INVALID VENDOR KEY” Invalid software API key
“ERROR: INVALID COMPANY UUID” Invalid company uuid
“ERROR: INVALID VALUES” Company_name, user_email or user_pw empty
“ERROR: REGISTRATION FAILED” Most likely company name already exists in Payslip service.

Sending

To send a letter to Mass printing service call the API endpoint https://payslip.maventa.com/input_public.

Headers for sending

You need to give authentication using HTTP headers. You can give either:

POST parameters for sending

Key Example Description
version MyOwnERP Name of the software (and its version) making the sending. Makes problem solving easier
filename letters_2019_12.zip Name of the ZIP package, should be unique
file RVBMMTExMzQ0O The actual ZIP file attached using multipart/form-data
zipHash 69a56b2b66d548d7b51f6dcc9003e90bafce2162 SHA1 hash of ZIP content, will get check in server to make sure package came through as whole
hash 856697ad0cae67ec48f7627be4cef74feaa2f36b SHA1 hash of PDF content, will get saved to server for duplicate prevention. Same hash key cannot be used for sending again
document_type PDFXML PDFXML
letter_class economy Economy or priority (default value). Letter class to use for sending
sw_api_key 5992955a-3b66-4439-94d1-a854a764da49 Existing software API key from Maventa. Value given in sending call will override the one set for the Payslip company account in registration
license_key 1234-5678-MKSK-1234 License key of software making the call (255 chars max)
license_meta License key for MyOwnERP Additional information about the licensing system
color_print true Color printinting true - Black&White false (default value)
duplex true Duplex printing for both sides of the letter. Default is false
prevent_digital_post true Prevent sending to OmaPosti. Default is false

Important: File upload must be done using the multipart/form-data content type. Do not send the file as a Base64-encoded string in a query parameter. If your integration currently does this, we recommend updating it to use multipart upload.

Response for sending

The response code will be a HTTP 200 and the response body is one of the following or “401 Unauthorized” if authentication fails:

Value Description
“OK: sent_filename.zip” Successful sending
“ERROR: HASH VALUE DOES NOT MATCH” Parameter zipHash does not match to the SHA1hash
“ERROR: ERROR: DUPLICATE FILE” Found file with parameter hash
“ERROR: FILE TOO LARGE” API allows max 10Mt files
“ERROR: DOCUMENT TYPE UNSUPPORTED” document_type is something else than PDFXML
“ERROR: FILE IS NOT ZIP” Parameter filename needs to be .zip
“ERROR: ZIP FILE CONTAINS UNSUPPORTED FILES” Only .pdf files are allowed
“ERROR: ZIP FILE CORRUPTED” Unzipping failed
“ERROR: NO LETTERS FOUND” No letter were found. No .pdf files found inside the zip file
“ERROR: SINGLE XML REFERENCES MULTIPLE PDFS” Single iPost-XML can only have reference to one PDF (XML to PDF 1-1 ratio)
“ERROR: sent_filename.zip” Unexpected error, sending failed. Contact our support for more information
“ERROR: LETTER OPTION MISMATCH” All IPost-XMLs in a ZIP file must have the same printing options (letter class, colour..) for billing purposes

Zip file content

PDFs

Example of iPost-XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<lb:LetterBundle schemaVersion="v0x4" senderFileId="FileD1" xmlns:lb="urn:itella-letterbundle-v0x4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:itella-letterbundle-v0x4 LetterBundle_V0x4.xsd">
  <lb:Bundle senderBundleId="">
    <lb:BundleCommon creationDate="2020-06-24T13:17:00.0Z" isTest="false">
      <lb:Sender companyName="Your company Oy" contact="" contactPerson="Support" email="support@support.com" phoneNumber="010-5058474" ovtID="003712345678">
        <lb:SenderAddress>
          <lb:Eu1 name="Your company Oy" address="PL 000" postalCode="00101" city="Helsinki" countryCode="FI"/>
        </lb:SenderAddress>
      </lb:Sender>
      <lb:StdBundleProcessing customerId="" departmentClassification="false" electronicArchiving="T" envelope="S" fileFormat="0" isDuplex="true" letterClass="2" paper="0" password="" serviceFunction="0"/>
      <lb:ExternalFile fileName="sent_filename.pdf" format="PDF" senderFileId="wm_0c5c09e0-03d3-4340-bb6b-0c3c14be7f42">
        <lb:CheckSum type="MD5" value="nnnnnnnnnnnnn"/>
      </lb:ExternalFile>
    </lb:BundleCommon>
    <lb:Letter senderLetterId="LetterID1">
      <lb:LetterMeta>
        <lb:Location pages="1" startPage="1"/>
        <lb:Recipient>
          <lb:Address>
            <lb:Eu1 address="Kotikatu 1" city="Helsinki" countryCode="FI" name="Asiakas Anssi" postalCode="01001"/>
          </lb:Address>
        </lb:Recipient>
      </lb:LetterMeta>
    </lb:Letter>
  </lb:Bundle>
</lb:LetterBundle>

Technical restrictions of the PDF

All files must be of PDF format (or have the same content requirements) for it to be printed correctly. That means that the file cannot contain dynamic components and that all fonts, images and others are included in the file (ie the files should be 100% “self-contained”). All new customers must test their PDF files (all variants of fonts, images, etc.) to verify that the PDFs can be handled. If the PDF contains graphics, such as logos, charts, and other images, they must be of good quality.

Instructions for letter layout

Your PDF letter needs to follow these PDF layout rules by Posti. Addition to Posti as the mail distributor, there is also Jakeluyhtiö Suomi Oy (JYS) which have few additions to the Posti rules. Difference is the tracking barcodes they print on the invoice image, see the JYS rules merged with the Posti ones.

Receiver information should be marked as clearly as possible to make sure machine readability.

Envelope size

The Finnish printing service uses two envelope sizes:

Since all invoices are printed double-sided, an invoice must have more than 18 pages before it exceeds 9 sheets and requires the C4 envelope.

Note: If the sender’s own invoice image is used without coversheet the cover sheet added by Maventa is counted as one page.

Checking the status of sent packages

To check the status of the sent package, use https://payslip.maventa.com/file_status.

Headers for checking the file status

You need to give authentication using HTTP headers. You can give either:

GET parameter for checking the file status

Key Example Description
filename sent_filename.zip Name of your ZIP package

Response for checking the file status

Value Description
“DONE” Package is processed and sent successfully
“PENDING” Package is still in sending process
“ERROR” Sending of the package has failed (in these cases our support will get notified and they will contact the sender with more detailed reason for error)
“ERROR: No file found” No file found with the given filename

Storage time

Once the file is successfully sent and we have gotten the final confirmation back from the print service provider, the file is completely remove from Maventa. We recommend storing the files on the ERP side for at least a few months after the sending in case there are some support cases related to the sent letters.

Delivery schedule

Letters that are sent to Maventa before 24:00 will get printed, processed and enveloped overnight and handed over to the mail distributor the following morning. Production does not take place during the weekends and holidays.

Delivery depends on the selected letter class. For Finnish companies sending domestic letters, there are two options: Priority and Economy.

For Finnish domestic letters, the practical difference between Priority and Economy classes is nowadays often minimal due to regional delivery schedules. these can have more impact on when the recipient receives the invoice than the selected letter class. Priority may still provide benefits for business-to-business invoices, but for consumer invoices, the recipient’s delivery schedule is usually the main factor.

For international letters, only priority is available.

OmaPosti delivery

OmaPosti is an application that allows customers to receive their letters electronically instead of in paper form. When a receiver has an active OmaPosti account and has not opted out of receiving digital letters from a specific sender (based on the sender’s ovtID given in the IPOSTXML), the invoice will be redirected to the receiver’s OmaPosti account instead of being delivered as a paper document. To determine if a receiver has an OmaPosti account, a combination of their name and postal address is used for identification.

It is also possible for the sender to exclude the letter from being sent through the OmaPosti route by setting the prevent_digital_post parameter to true in the sending API call.

Please note that in order for the OmaPosti route to function, the necessary information must be specified in the IPOSTXML document. This includes the sender’s OVT code (ovtID) and the receiver’s name and address information.

User account closing

If you wish to close the service please contact Maventa support.

Back to top