RedHorn Visma Business API

A REST based web API enabling access to Visma Business resources over HTTP

Swagger

All available resources (about 350 in total), and there endpoints can be examined via the Swagger documentation.

Swagger documentation »

Documentation

Further documentation is found on RedHorn Business Integration Suite web site. The documentation aim to help you to get an understanding of the core principles of this API and help you get started using it.

RedHorn Business Integration Suite »

Release notes

Version 1.5

  • Support to define custom database names for the company independent databases (default "vbsys" and "Catalog") in appsettings.json.
  • Support to encrypt some configuration settings that potentially contains sensitive information. This prevents users that are logged in to the web server (that is hosting the Web API) to see the configuration settings in the configuration file.

Version 1.4

  • Pagination and count support with the OData query options $orderBy, $skip, $top and $count.
    • The following example with query options in the URL would result in a query that skips the first 100 records and return the next 10 records, where the records are ordered by productNo: 
      $orderby=productNo&$skip=100&$top=10
    • If the URL also contains the query option $count=true the response will include a separate property with the total number of records matching the provided query filter, but not affected by pagination options (skip/top).

  • Support to assign a value from the number series for a non primary key property (e.g. CustomerNo, SupplierNo and EmployeeNo for the Associate resource).
    • Use the optional property NumberSerieAssignments in the save request to define non primary key properties that should get assigned from it's number serie in Visma.
    • If multiple series exists for current type in Visma (that is not excluded from lookup), a default serie have to be defined in "Company data" in Visma or in the Web API configuration per API user and company.

  • The content of the configuration file (appsettings.json) have to be adjusted to enable custom settings per API user and company (e.g. NumberSerieAssignments):
    • The type of the property AccessibleCompanies within the ApiUser object is changed from a list of integers to a list of objects.
      Replace: 
      "AccessibleCompanies": [ 9999, 9998 ]
      With: 
      "AccessibleCompanies": [ { "CompanyNo": 9999 }, { "CompanyNo": 9998 } ]

  • Improved automatic licence renewal support via Licence Service Web API.
  • Extended Swagger documentation.

Version 1.3

  • Support for Token-based authentication in addition to the existing Basic authentication.
    • Basic authentication will still be available in parallell by default (for backwards compatibility).
    • You can disable Basic authentication per API user by setting the property AllowBasicAuthentication to false in the appsettings.json file.

  • Support for automatic product licence renewal via Licence Service Web API
    • New licence file required
    • In the configuration file (appsettings.json) - the new setting "LicenceServiceBaseUrl" replaces "LicencePublicKey"

  • The product is rebranded and the new name is "RedHorn Visma Business API" (before "Capremill Visma Business Access API").

Version 1.2

  • New response structure for POST/PUT requests
    • HTTP status 207 for partially successful operation
    • HTTP status 422 if no operation succeeded
    • The SaveOperationResult property for each record in the response contains save operation result information for that particular record (see the SaveOperationResult object in Swagger).

  • Custom assignment order for property values against Visma/VBS
    • Use the optional property CustomPropertyAssignmentSequence in the save request to define a custom assignment order. Declare the properties that have to be assigned first to accomplish the desired effect in Visma (according to Visma Business rules), and the rest will end up in default order (see order in Swagger) after.

  • Support for Visma Data Model Extension (DME)
    • By including DME when generating the Model dll (RedHorn.VismaBusiness.Model.dll) - the model extensions will also be available via the Web API.

  • Improved/secured implementation for simultaneous calls to one resource.