VismaBouwsoftAPICalls.v1_GET_OrderCosts Method
v1_GET_OrderCosts() as String

This API call is used to get fields of a(n) OrderCost(s)

HTTP method API version
GET v1

Don’t forget to put the Authorization field in the header

API Path: /OrderCosts/
or
API Path: /OrderCosts/{id}

You can make this API call:
* without the key field id to get a list of OrderCosts
* with the key field id as the path parameter (the specific id of the OrderCost you want to get)

Fields

The following fields are available:

Field Name Type
id Number
order_id Number
nr String
description String
amount Number
amount_total Number
percent Number
applyto_order Boolean
applyto_chapter Number
applyto_part Number
applyto_group String
application_localized String

/OrderCosts/

API Path: /OrderCosts/

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/OrderCosts

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GrAfWxfDtDzSfOkIOfzRqOVkfOUPGfAlfAkbzbmIODGfOGkVbA

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/187”, “Records”: [
  {
    "id": 14,
    "order_id": 260,
    "nr": "",
    "description": "offerte kosten",
    "amount": 60.0,
    "amount_total": 0.0,
    "percent": 10,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  },
  {
    "id": 15,
    "order_id": 260,
    "nr": "",
    "description": "overnachting",
    "amount": 100.0,
    "amount_total": 0.0,
    "percent": 0,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
,

]
}

/OrderCosts/{id}

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/OrderCosts/14

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GrAfWxfDtDzSfOkIOfzRqOVkfOUPGfAlfAkbzbmIODGfOGkVbA

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 14,
    "order_id": 260,
    "nr": "",
    "description": "offerte kosten",
    "amount": 60.0,
    "amount_total": 0.0,
    "percent": 10,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
]
}

https://ra.bouwsoft.be/api/v1/OrderCosts/1443

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GrAfWxfDtDzSfOkIOfzRqOVkfOUPGfAlfAkbzbmIODGfOGkVbA

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 1443,
    "order_id": 16124,
    "nr": "",
    "description": "",
    "amount": 0.0,
    "amount_total": 0.0,
    "percent": 0,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
]
}

https://ra.bouwsoft.be/api/v1/OrderCosts/1443

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jbffWxfDbGzSflPVVfzRqtlbfOfIGfDGflVbzVlAlPfflkAAGk

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 1443,
    "order_id": 16124,
    "nr": "",
    "description": "API added costs",
    "amount": 1.5,
    "amount_total": 0.0,
    "percent": 0,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
]
}