This endpoint allows you to retrieve the information of the business type your application is authorized to.

In order to use this endpoint:

  • Check that your application is authorized to the businesstypes:list scope in the Visma Developer Portal
  • Create a Get request to the method’s /businesstypes/{id} URI, where {id} is the id of the business type your application is authorized to

Example - Get Business Type Request

GET https://fileapi.youforce.com/v1.0/businesstypes/8000
GET v1.0/businesstypes/8000
HTTP/1.1
Host: fileapi.youforce.com
Authorization: Bearer xxxxxxxxx

If the request succeeds, the response includes a 200 OK HTTP status code, along with the business type information.

Example - Response of Get Business Type

HTTP/1.1 200
Content-Type: application/json

{
    "id": 8000,
    "tenantId": "6401970"
}

Response fields

Field Type Description
id integer The id of the business type.
tenantId string The tenantid your application is authorized to for this business type.

Possible errors

HTTP status Situation
400 The business type id is not a valid non-negative integer.
401 Missing or invalid access token.
404 The business type does not exist, or your application is not authorized to it (both cases return 404).

Example - Response when the business type does not exist, or your application is not authorized to it

HTTP/1.1 404
Content-Type: application/json

{
    "CorrelationId": "rrt-06f2e934a3cbdb710-a-de-13067-4959526-1",
    "Message": "Business type <8000> not found.",
    "ErrorCode": "404",
    "Exception": null
}