VismaBouwsoftAPICalls.v1_PUT_Orders

Method

v1_PUT_Orders() as String

This API call is used to update fields of a(n) Order

General Description

HTTP method	API version
PUT	v1

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

API Path: /Orders/{id}
or
API Path: /Orders/{id}/conclusion_plain
or
API Path: /Orders/{id}/introduction_plain

You make this API call with the key field id as the path parameter (the id of the Order you want to update)

Fields

The following fields are available:

Field Name	Type
id	Number
expirationdate	String
ts_lastupdate	String
approved	Boolean
approved_date	String
billed	Boolean
project_id	Number
project_pnr	Number
project_unr	Number
project_name	String
address_id	Number
address_salutation	String
address_name	String
address_address	String
address_latitude	Number
address_longitude	Number
address_zipcode	String
address_city	String
vatnr	String
email	String
company_id	Number
company_name	String
nr	Number
date	String
contact_id	Number
contact_salutation	String
contact_name	String
telephone1	String
fax	String
gsm	String
yourreference	String
creditlimitation_expirationdate	String
creditlimitation_percent	Number

/Orders/{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/Orders/16124

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: expirationdate=’2020–12–25’

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 16124,
    "expirationdate": "2020–12–25",
    "ts_lastupdate": "2025–02–12 14:29:26"
  }
]
}

https://ra.bouwsoft.be/api/v1/Orders/16124

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: billed=false,approved=false

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 16124,
    "approved": false,
    "approved_date": "",
    "billed": false,
    "ts_lastupdate": "2025–02–12 14:31:57"
  }
]
}

https://ra.bouwsoft.be/api/v1/Orders/16124

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: project_id=278

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 16124,
    "project_id": 278,
    "project_pnr": 20140143,
    "project_unr": 0,
    "project_name": "SupportTest Andy Plaatsen Deuren",
    "ts_lastupdate": "2025–02–12 14:29:29"
  }
]
}

https://ra.bouwsoft.be/api/v1/Orders/16124

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: address_id=42178

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 16124,
    "expirationdate": "2018–07–03",
    "address_id": 42178,
    "address_salutation": "",
    "address_name": "SupportTest Andy",
    "address_address": "Molenweg 9",
    "address_latitude": 51.231999999999999,
    "address_longitude": 3.164,
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "vatnr": "",
    "email": "",
    "project_id": 860,
    "project_pnr": 20170101,
    "project_unr": 402,
    "project_name": "Test mobiliteit en verplaatsing home-work"
  }
]
}

https://ra.bouwsoft.be/api/v1/Orders/16124

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: date=’2018–06–02’,company_id=1,address_id=167199,creditlimitation_percent=3

Success gives statuscode 200 And the following result

{“RecordChanges”: [
  {
    "id": 16124,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "nr": 2020001046,
    "date": "2018–06–02",
    "expirationdate": "2018–07–13",
    "address_id": 167199,
    "address_salutation": "Dhr. En Mevr.",
    "address_name": "Spike needle (BS Test Recipient 1)",
    "contact_id": 0,
    "contact_salutation": "",
    "contact_name": "",
    "vatnr": "BE0407781169",
    "telephone1": "",
    "fax": "",
    "gsm": "",
    "email": "spikkel@gmail.com",
    "project_id": 2807,
    "project_pnr": 20220127,
    "project_unr": 0,
    "project_name": "Spikesoft project Varsenare",
    "yourreference": "",
    "creditlimitation_expirationdate": "2018–06–09",
    "creditlimitation_percent": 3,
    "ts_lastupdate": "2025–02–12 14:29:25"
  }
]
}

/Orders/{id}/conclusion_plain

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/Orders/16124/conclusion_plain

with the following parameters :

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

Body Parameters :
Conclusion added by api

Success gives statuscode 200 And the following result

Conclusion added by api

/Orders/{id}/introduction_plain

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/Orders/16124/introduction_plain

with the following parameters :

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

Body Parameters :
Introduction added by api

Success gives statuscode 200 And the following result

Introduction added by api