| VismaBouwsoftAPICalls.v1_POST_OrderLines | Method |
This API call is used to add a(n) OrderLine
General Description
| HTTP method | API version |
|---|---|
| POST | v1 |
Don’t forget to put the Authorization field in the header
API Path: /OrderLines
or
API Path: /OrderLines/{id}/ActualizePrice
or
API Path: /OrderLines/{id}/Copy
or
API Path: /OrderLines/{id}/Move
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| orderid | Number |
| ordertype | String |
| ordernr | Number |
| order_address_id | Number |
| order_address_name | String |
| order_project_id | Number |
| order_project_pnr | Number |
| linenr | Number |
| linkedto_type | String |
| linkedto_type_localized | String |
| linkedto_source | Number |
| linkedto_id | Number |
| group | String |
| nr1 | String |
| nr2 | String |
| description | String |
| unit1 | String |
| unit2 | String |
| unit1_localized | String |
| unit2_localized | String |
| quantity1 | Number |
| quantity2 | Number |
| quantity3 | Number |
| quantity4 | Number |
| quantity_total | Number |
| all_quantities_are_included_in_quantity_total | Boolean |
| price_unit | Number |
| discount | Number |
| price_total | Number |
| vatcode | String |
| vatpercent | Number |
| vatcocontractor | Boolean |
| ledger | Number |
| price_unit_afterdiscount | Number |
| cost_products | Number |
| margin_products | Number |
| cost_hours | Number |
| margin_hours | Number |
| hours_unit | Number |
| hours_total | Number |
| cost_machines | Number |
| margin_machines | Number |
| cost_subcontractors | Number |
| margin_subcontractors | Number |
| margin_fixed | Number |
| info_brand | String |
| info_type | String |
| planned_quantity | Number |
| project_id | Number |
| project_pnr | Number |
| project_unr | Number |
| project_name | String |
| supplier_id | Number |
| supplier_nr | Number |
| supplier_name | String |
| include_line_in_total | Boolean |
| include_line_on_print | Boolean |
| start_on_new_page | Boolean |
| ts_lastupdate | String |
/OrderLines
API Path: /OrderLines/
If everything succeeds the HTTP response status is 201
(201 CREATED)
If you forget to send the Authorization, the response status and code is 401
(401 Unauthorized)
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/OrderLines
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bAlfWxfbAIzSflbrrfzRqOfkffAIfGljfbAkzGUjjtOGlDjAtG
Query Parameters :
ParameterName: columns, ParameterValue: orderid=16124
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 139690,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 1,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:06"
}
]
}
https://ra.bouwsoft.be/api/v1/OrderLines
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: ODrfWxflmGzSfAbfAfzRqfkDfVmtfGkffjOkzVkOlVDGPfffmU
Query Parameters :
ParameterName: columns, ParameterValue: orderid=16124
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 139691,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 2,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:06"
}
]
}
/OrderLines/{id}/ActualizePrice
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/OrderLines/139690/ActualizePrice
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bAlfWxfbAIzSflbrrfzRqOfkffAIfGljfbAkzGUjjtOGlDjAtG
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 139690,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 1,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:12"
}
]
}
/OrderLines/{id}/Copy
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/OrderLines/139690/Copy
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bAlfWxfbAIzSflbrrfzRqOfkffAIfGljfbAkzGUjjtOGlDjAtG
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 139692,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 2,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:15"
}
]
}
https://ra.bouwsoft.be/api/v1/OrderLines/139692/Copy
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bAlfWxfbAIzSflbrrfzRqOfkffAIfGljfbAkzGUjjtOGlDjAtG
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 139693,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 3,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:18"
}
]
}
/OrderLines/{id}/Move
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/OrderLines/139690/Move
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GkffWxfDAjzSfjlrbfzRqljAfkVkfGAkfUfkzkjrrODGkGDfkD
Query Parameters :
ParameterName: down, ParameterValue: 1
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–2/3”,
“Records”:
[
{
"id": 139690,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 1,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:15"
},
{
"id": 139692,
"orderid": 16124,
"ordertype": "FAKTUUR",
"ordernr": 2020001046,
"order_address_id": 42178,
"order_address_name": "SupportTest Andy",
"order_project_id": 278,
"order_project_pnr": 20140143,
"linenr": 2,
"linkedto_type": "",
"linkedto_type_localized": "",
"linkedto_source": 0,
"linkedto_id": 0,
"group": "",
"nr1": "",
"nr2": "",
"description": "",
"unit1": "",
"unit2": "",
"unit1_localized": "",
"unit2_localized": "",
"quantity1": 0,
"quantity2": 1,
"quantity3": 1,
"quantity4": 1,
"quantity_total": 0,
"all_quantities_are_included_in_quantity_total": true,
"price_unit": 0.0,
"discount": 0,
"price_total": 0.0,
"vatcode": "21",
"vatpercent": 21,
"vatcocontractor": false,
"ledger": 700000,
"price_unit_afterdiscount": 0.0,
"cost_products": 0.0,
"margin_products": 0,
"cost_hours": 0.0,
"margin_hours": 0,
"hours_unit": 0,
"hours_total": 0,
"cost_machines": 0.0,
"margin_machines": 0,
"cost_subcontractors": 0.0,
"margin_subcontractors": 0,
"margin_fixed": 0,
"info_brand": "",
"info_type": "",
"planned_quantity": 0,
"project_id": 278,
"project_pnr": 20140143,
"project_unr": 0,
"project_name": "SupportTest Andy Plaatsen Deuren",
"supplier_id": 0,
"supplier_nr": 0,
"supplier_name": "",
"include_line_in_total": true,
"include_line_on_print": true,
"start_on_new_page": false,
"ts_lastupdate": "2025–02–12 14:30:15"
}
,
…
]
}