Services
NOTE: Fix table below.
Services
When creating messages on the messaging server, the sender has the option to trigger additional document processing. This is managed through services.
Depending on the service type, services are configured in one the following ways:
-
For the server (General server settings).
- For the sending party (Party settings). 3. On the message level (Arguments).
When services are set for an individual message, the user supplies a list of service parameters in the API call.
Each service is identified with a unique service identifier. For more information about how to configure and use a particular service, refer to the service description.
To view the service status, sign in on your account in the eefacta Server UI. Select the message for which you want to see the services, then go to the Services tab. The service status shows you whether the service has been successfully performed or not.
The following services are available:
| Service | Identifier | Availability |
|---|---|---|
| Skip dispatching | urn:services:generic:allow\.no.dispatch | Global |
| Send through email | urn:services:dispatcher:mail.pdf | Global |
| Sending a claim to bank | urn:services:banking:claim | Local (Iceland) |
| Sending document to bank | urn:services:banking:document | Local (Iceland) |
| Printing at Oddi Printing Center | urn:services:oddi:print | Local (Iceland) |
| Printing at NoInk | urn:services:noink:print.mail.pdf | Local (Sweden) |
Skip dispatching
When you specify this service parameter, you can create a message on the server without requiring delivery (dispatching) of the message to the receiving party. Therefore, you can use this parameter when you want to use another service, such as Send through email, and avoid getting a "Participant not found" error if the user is not registered on the server or found in any external networks.
The receiving party does not need to be registered on the Messaging Server.
| Parameter | urn:services:generic:allow.no.dispatch |
| General server settings | None |
| Party settings | None |
| Arguments | None |
Send through email
When the business document is pushed to the server, it can be forwarded through email in PDF format.
| Parameter | urn:services:dispatcher:mail.pdf |
| General server settings | None |
| Party settings | None |
| Arguments | The sender must specify the email address to which the business document will be sent, for example, [email protected].
The argument is then supplied at the end of the parameter, as shown in the following example: urn:services:mail:[email protected].
Additional parameters can be specified, supported is lang and attachpdf.
Example: urn:services:dispatcher:[email protected]#$#lang=en#$#attachpdf=true |
Sending a claim to bank
The sender has the possibility of sending a claim to the receiver’s online bank.
The document is sent on behalf of the sender using credentials and a machine certificate, encrypted centrally.
Currently, these banks are supported:
- Íslandsbanki, Arion banki, Landsbanki
- Kvika, Sparisjóðirnir, Seðlabankinn, InKasso
Service configuration
| Parameter | Description |
|---|---|
| Parameter | urn:services:banking:claim |
| General server settings | The application is configured to connect with a centralized banking hub integration. It allows users to send claims with the invoices directly to the banks. |
| Party settings | Required party setting for sending claims are the client credentials that are encrypted using AES and a secret encryption key. These are set up on the messaging server by Unimaze. - Namespace: urn:services:banking:claim- Name: ClientCredentials |
| Arguments | The sender provides the following: - accountNo (example: 012366004321)- dueDate (example: 2023-05-27)- graceDate (example: 2023-05-29)- cancellationDate (example: 2023-06-15)The arguments can be specified in any order. Arguments are delimited using #$#.The following example shows how the parameter with arguments are set up: urn:services:banking:claim?accountNo=013066000001#$#dueDate=2023-04-24#$#graceDate=2023-04-25#$#cancellationDate=2023-05-24accountNo and dueDate can either both be specified as parameters, or they can be specified inside the invoice document. If they are not both specified as parameters, they are taken from the invoice. In the invoice the accountNo is taken from the payment means using payment means code 49 in older standards (TS-136, BII/NES) and code 9 in newer standards (Peppol BIS3 / European Norm and later). graceDate is optional. graceDate must be set to a later date than the due date. If graceDate is not specified, it is found on the invoice. If it is not specified on the invoice either, it is set as the same date as the dueDate. cancellationDate is optional. If cancellationDate is not specified, it is set as one year after the dueDate. cancellationDate must be set at least 30 days later than due date. Both the sender and receiver legal entities identifiers must be specified in the invoice. Example of payment means for older standard used for accountNo and dueDate: Example of where graceDate is taken from in older standard: Example of where dueDate is taken from newer standards: Example of payment means for newer standards used for accountNo: Example of where graceDate is taken from newer standards: |
Sending document to bank
The sender has the possibility of sending a document to the receiver’s online bank.
The document is sent on behalf of the sender using credentials and a machine certificate, encrypted centrally.
Currently, these banks are supported:
- Íslandsbanki
Service configuration
| Parameter | Description |
|---|---|
| Parameter | urn:services:banking:document |
| General server settings | The application is configured to connect with a centralized banking hub integration. It allows users to send document with the invoices directly to the banks. |
| Party settings | Required party setting for sending documents are the client credentials that are encrypted using AES and a secret encryption key. These are set up on the messaging server by Unimaze. - urn:services:banking:document:credentials stores the encrypted username and password- urn:services:dispatcher:company.logo.base64 and urn:services:dispatcher:company.logo.content.type store the optional company logo in the required format (size, proportions), encoded as BASE64 media type |
| Arguments | The sender provides the following: No arguments are required. |
Printing at Oddi Printing Center
During dispatching, business documents can also be delivered to Oddi's Printing Center.
Oddi prints and handles the document according to the contract signed with the sender.
Service configuration
| Parameter | Description |
|---|---|
| Parameter | urn:services:oddi:print |
| General server settings | The messaging server is integrated with Oddi's Printing Center. Oddi sets up a folder for the sending party, as well as a username and password. When documents are distributed to Oddi, default credentials are used. In case of dealing with large numbers of documents, the sender typically signs a direct contract with Oddi. |
| Party settings | If the sender has an agreement concluded with Oddi, Oddi provides a username and password that are then registered in the sender's account on the messaging server. The settings are as follows: - urn:services:oddi:print:username- urn:services:oddi:print:passwordIf you do not have a contract signed with Oddi, you need to enter one of the following: - urn:services:oddi:print:use.default.credentials=true- urn:services:oddi:print:use.default.credentials=1 |
| Arguments | You need to specify the username and password obtained when signing up with Oddi:User=username#&#Password={auth:pwd}These credentials are then replaced in the sender's account on the messaging server. |
Printing at NoInk
The sender has the possibility of having their business documents printed and further distributed, for example by postal mail, by NoInk in Sweden.
In this case, the document is forwarded to NoInk when it is dispatched to the messaging server.
NoInk prints the document and dispatches it in accordance with the contract concluded with the sender.
Service configuration
| Parameter | Description |
|---|---|
| Parameter | urn:services:noink:print.mail.pdf |
| General server settings | The application is configured to connect with the NoInk communication server. The sender is assigned a folder and user credentials. Business documents are transferred to NoInk using default credentials. Otherwise, typically in cases where the sender needs to print large quantities of documents, the sender signs a direct contract with NoInk. |
| Party settings | If the sender has a contract signed with NoInk, the username and password provided by NoInk need to be registered on the sender's account on the messaging server. The settings are as follows: - urn:services:noink:print:username- urn:services:noink:print:password |
| Arguments | The sender provides the following: - The username and password received when signing up with NoInk: User=username#$#Password={auth:pwd}The credentials are then replaced on the sender’s account on the messaging server. - The language (optional). You can choose between English and Icelandic, for example: lang=enIf the language is not supplied, Icelandic is used by default. The arguments can be specified in any order. Arguments are delimited using #$#.Example: User=notandi#$#Password=password#$#lang=is |
Updated 3 months ago