About the Visma.net ERP category

Alumio_Bot · September 21, 2022, 11:14am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Visma API Reference

Connector package documentation

1. Setting up HTTP Client Visma

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Visma HTTP Client as PlatForm and click next step
Fill in the Authentication type and Environment Type.
Then complete the field base on the Authentication Type you choose.
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Visma

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select either “Visma ERP Service Subscriber” or “Visma ERP SalesOrder Subscriber” as the subscriber.
Select the entity you want to subscribe to from Visma.
Add any request parameters needed to subscribe to the entity.
Select the Visma HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from Visma.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Visma documentation on building this connector, so you can easily use the connector based on Visma API Reference.

Entity

The entity you want to subscribe to Visma. Please refer to the entities from Visma API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Visma API Reference.

Please look at the example below on how to fill path field when subscribing “Vat - Get a specific Vat” entity from “Visma ERP Service Subscriber”.

Based on the end point, we can see that the end point require “vatId” as a parameter. That is why we set the “vatId” inside the path key in the Request Parameters.

Alumio will then make a request to Visma with the URL /controller/api/v1/vat/01 and Visma will give response like (you can enable logging in the HTTP Client to see this log)

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access Visma.

3. Publishing Entity to Visma

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select either “Visma ERP Service Publisher” or “Visma ERP SalesOrder Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the Visma entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support Create (HTTP POST method), Update (HTTP PUT method), Patch (HTTP Patch method) and Delete (HTTP DELETE method) on submitting data to Visma.

Entity

We support publishing to most Visma endpoints.
Please refer to Visma API Reference page.

For example, we want to add a new sales order to the system on “Visma ERP SalesOrder Publisher”. Please select “Post” as the Method and “Add a new sales order to the system” as the entity of the publisher.

Based on the documentation, it requires a request body. That is why we set the request body inside the payload key inside Alumio data.

Alumio will send an API request to Visma with URL /api/v3/SalesOrders

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.