Get started Integration Guide Services & Reach API Specification Changelogs
Search
API overview REST API Getting Started Common & authentication API Invoices API Documents API Companies & settings API Lookups API Detect API Validator API Receivables API Billing API Scanning API B2CFI API B2CNO API B2CSE API Partner API SOAP API Getting Started Account Configuration API Methods Invoice Sending API Methods Invoice Receiving API Methods B2C Norway API Methods B2C Finland API Methods Other API Methods

B2C Finland API Methods

API methods for consumer invoicing in Finland. For new integrations, we recommend using the REST API instead. B2C Finland uses a separate WSDL from the main SOAP API:

message_send

Used for sending SI-messages for B2C Finland. Returns OK and new message ID or ERROR.

The message needs to be XSD schema valid and complete. It will be sent to the bank as-is — no additions or conversions are made.

The system returns OK immediately when the message has been sent successfully. Between banks, B2C messages can travel with a delay of up to 1–4 banking days. Possible error messages can arrive even after a week. If the message fails on the bank side you will get an error. If the message is accepted, no separate confirmation message is sent.

 
/banks/api/message_send

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key

message (base64)

Key Type Description
file base64 SI-message file

Output

return (MessageResponse)

Key Type Description
status string Status string, includes OK or ERROR
message_id string 36 character UUID of new SI-message if successfully created

Return values

Key Type Message Description
return string OK  
    ERROR: DUPLICATE MESSAGEID Given message ID is duplicate
    ERROR: ONLY ONE MESSAGE PER FILE ALLOWED  
    ERROR: SOAP HEADER MISSING  
    ERROR: USER NOT FOUND  
    ERROR: COMPANY BANK CONNECTION NOT ACTIVE  
    ERROR: INVALID SENDER INTERMEDIATOR  
    ERROR: MESSAGE NOT FOUND OR NO RIGHTS  

message_status

Used for getting the status of a sent SI-message. Uses the UUID returned by the message_send method.

In case an SI-message ends up in an error state on the sending bank side, error_message_list only returns the SI-message status as ERROR and does not return any error reasons.

 
/banks/api/message_status

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
message_id string UUID message_id

Output

return (MessageStatus)

Key Type Description
status string Status string, includes OK or ERROR
message string Message

Return values

Key Type Message Description
return string OK  
    ERROR: USER NOT FOUND  
    ERROR: MESSAGE NOT FOUND OR NO RIGHTS  

error_message_list

Used for listing error messages based on given timestamps. Returns status and a table that contains id and original_id (refers to the SI-message UUID).

/banks/api/error_message_list

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
timestamp_start string Start time for search, format YYYYMMDDHHMMSS
timestamp_end string End time for search, format YYYYMMDDHHMMSS

Output

return (ErrorList)

Key Type Description
status string Status
error_messages ErrorListMessageOut A table that contains id and original_id (refers to the SI-message UUID)

error_messages (ErrorListMessageOut)

Key Type Description
id string Error message ID
original_id string SI-message UUID

Return values

Key Type Message Description
status string OK  
    ERROR: TIMESTAMP FORMAT INVALID FOR START TIMESTAMP  
    ERROR: TIMESTAMP FORMAT INVALID FOR END TIMESTAMP  
    ERROR: USER NOT FOUND  
    ERROR: UNKNOWN ERROR  

error_message_show

Used to download a separate message from the bank that contains the error reason.

/banks/api/error_message_show

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
error_message_id string Error message ID (UUID)

Output

return (ErrorMessageOut)

Key Type Description
status string Status of the API call
error_message base64 File contents in base64 format

Return values

Key Type Message Description
status string OK  
    ERROR: USER NOT FOUND  
    ERROR: MESSAGE NOT FOUND OR NO RIGHTS  

ri_message_list

Used to list UUIDs for RI (Return Information) messages received based on given timestamps. Returns status and a table that contains UUIDs.

/banks/api/ri_message_list

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key (mandatory)
Key Type Description
timestamp_start string Start time for search, format YYYYMMDDHHMMSS
timestamp_end string End time for search, format YYYYMMDDHHMMSS

Output

return (RiList)

Key Type Description
status string Status of the API call
ri_message_ids Array RI-message IDs

Return values

Key Type Message Description
status string OK  
    ERROR: TIMESTAMP FORMAT INVALID FOR START TIMESTAMP  
    ERROR: TIMESTAMP FORMAT INVALID FOR END TIMESTAMP  

ri_message_show

Used to download an RI (Return Information) message.

/banks/api/ri_message_show

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
ri_message_id string RI-message ID (UUID)

Output

return (RiMessageOut)

Key Type Description
status string Status of the API call
ri_message base64 File contents in base64 format

Return values

Key Type Message Description
status string OK  
    ERROR: USER NOT FOUND  
    ERROR: MESSAGE NOT FOUND OR NO RIGHTS  

ri_message_delete

Used to remove a single RI (Return Information) message by ID. Returns OK or ERROR as status.

/banks/api/ri_message_delete

Input

api_keys (ApiKeys)

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
ri_message_id string RI-message ID (UUID)

Output

Key Type Description
status string Status of the API call, OK/ERROR

Return values

Key Type Message Description
status string OK  
    ERROR: USER NOT FOUND  
    ERROR: MESSAGE NOT FOUND OR NO RIGHTS  
Back to top
Give feedback Contact sales Chat with support

AI Chat Support 24/7

  • • Get help via AI chat available 24/7 whenever it suits you
  • • Chat extensively uses Maventa support pages, websites, and blogs in its answers
  • • If you need assistance that the AI cannot provide, you can also ask a customer service agent to join the conversation
  • • Support requests processed Monday to Friday
Cancel Open chat

Got feedback?

Did you not find what you were looking for? Or was something explained unclearly? Or just want to share your thoughts? We are happy to hear your feedback!

Note: This form is not a way to get support, this is only for feedback for the documentation website. If you need support, please contact Maventa support.

Integration Guide Services & Reach API Specification Changelogs Integration guide Getting Started Invoice sending Consumer Invoicing Printing Email invoicing Invoice receiving Scanning Detect Fraud reporting Webhooks Reference implementations Maventa Connector Embeddable User Interface Peppol Network Document Exchange Invoice Response Self-billing support Invoicing formats Validation Peppol BIS 3.0 Finvoice 3.0 Document types and type codes Maventa JSON (table) Maventa JSON (json schema) Companies and Settings Department Company Users Billing Accounts receivable Ropo's reminder and collection service Amili Kassavirta Amili Perintä Services and reach Maventa services and reach e-invoicing in Finland Mass Printing Service e-invoicing in Sweden e-invoicing in Norway e-invoicing in Denmark e-invoicing in the Netherlands e-invoicing in Belgium e-invoicing in Germany e-invoicing in Estonia e-invoicing in Latvia e-invoicing in Poland e-invoicing in Italy e-invoicing in France e-invoicing in Spain Api specification API overview Getting Started Common & authentication API Invoices API Documents API Companies & settings API Lookups API Detect API Validator API Receivables API Billing API Scanning API B2CFI API B2CNO API B2CSE API Partner API Getting Started Account Configuration API Methods Invoice Sending API Methods Invoice Receiving API Methods B2C Norway API Methods B2C Finland API Methods Other API Methods Changelogs Product changelog Developer Changelog
Clear Send

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