| VismaBouwsoftAPICalls.v1_GET_Orders | Method |
This API call is used to get fields of a(n) Order(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Orders/
or
API Path: /Orders/{id}
or
API Path: /Orders/{id}/conclusion_html
or
API Path: /Orders/{id}/conclusion_plain
or
API Path: /Orders/{id}/conclusion_rtf
or
API Path: /Orders/{id}/introduction_html
or
API Path: /Orders/{id}/introduction_plain
or
API Path: /Orders/{id}/introduction_rtf
or
API Path: /Orders/{id}/pdf
You can make this API call:
* without the key field id to get a list of Orders
* with the key field id as the path parameter (the specific id of the Order you want to get)
Fields
The following fields are available:
| Field Name | Type |
|---|---|
| id | Number |
| company_id | Number |
| company_name | String |
| type | String |
| type_localized | String |
| type_id | Number |
| nr | Number |
| nr_add | String |
| date | String |
| expirationdate | String |
| title | String |
| concerning | String |
| ordernr | String |
| pricedecimals | Number |
| ledger | Number |
| workingdocumentdata_id | Number |
| address_id | Number |
| address_salutation | String |
| address_name | String |
| address_address | String |
| address_addressline2 | String |
| address_latitude | Number |
| address_longitude | Number |
| address_countrycode | String |
| address_zipcode | String |
| address_city | String |
| address_state | String |
| address_readonly | Boolean |
| shippingaddress_address | String |
| shippingaddress_addressline2 | String |
| shippingaddress_latitude | Number |
| shippingaddress_longitude | Number |
| shippingaddress_countrycode | String |
| shippingaddress_zipcode | String |
| shippingaddress_city | String |
| shippingaddress_state | String |
| contact_id | Number |
| contact_salutation | String |
| contact_name | String |
| vatnr | String |
| gln | String |
| be_rpr | String |
| telephone1 | String |
| telephone2 | String |
| fax | String |
| gsm | String |
| String | |
| project_id | Number |
| project_pnr | Number |
| project_unr | Number |
| project_name | String |
| yourreference | String |
| be_werkplaatsnr30bis | String |
| basis | Number |
| vatcode | String |
| vatpercent | Number |
| vatamount | Number |
| amountinclvat | Number |
| basis1 | Number |
| taxableamount1 | Number |
| vatcode1 | String |
| vatpercent1 | Number |
| vatcocontractor1 | Boolean |
| vatamount1 | Number |
| amountinclvat1 | Number |
| basis2 | Number |
| taxableamount2 | Number |
| vatcode2 | String |
| vatpercent2 | Number |
| vatcocontractor2 | Boolean |
| vatamount2 | Number |
| amountinclvat2 | Number |
| basis3 | Number |
| taxableamount3 | Number |
| vatcode3 | String |
| vatpercent3 | Number |
| vatcocontractor3 | Boolean |
| vatamount3 | Number |
| amountinclvat3 | Number |
| basis4 | Number |
| taxableamount4 | Number |
| vatcode4 | String |
| vatpercent4 | Number |
| vatcocontractor4 | Boolean |
| vatamount4 | Number |
| amountinclvat4 | Number |
| basis5 | Number |
| taxableamount5 | Number |
| vatcode5 | String |
| vatpercent5 | Number |
| vatcocontractor5 | Boolean |
| vatamount5 | Number |
| amountinclvat5 | Number |
| cashdiscount_expirationdate | String |
| cashdiscount_percent | Number |
| cashdiscount_amount | Number |
| creditlimitation_expirationdate | String |
| creditlimitation_percent | Number |
| creditlimitation_amount | Number |
| commercialdiscount_percent | Number |
| distributeddiscount_amount | Number |
| include_commission_in_total | Boolean |
| advance | Number |
| balance | Number |
| blocked | Boolean |
| locked | Boolean |
| createdby | String |
| lasteditedby | String |
| approved | Boolean |
| approved_date | String |
| rejected | Boolean |
| rejected_date | String |
| verified | Boolean |
| sent | Boolean |
| sent_date | String |
| signed | Boolean |
| billed | Boolean |
| detail_source | Number |
| detail_sourcelist | String |
| detail_ordergroups | Boolean |
| ts_lastupdate | String |
| profit_gross | Number |
| profit_gross_percent | Number |
| profit_net | Number |
| profit_net_percent | Number |
/Orders/
API Path: /Orders/
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/Orders
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VItfWxfbrfzSfbVlVfzRqDrUfVrjfGfPfPbkzDmmjfVGDGGbbb
Query Parameters :
ParameterName: filter, ParameterValue: type eq ‘OFFERTE’
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/2162”,
“Records”:
[
{
"id": 22,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "OFFERTE",
"type_localized": "OFFER",
"type_id": 1,
"nr": 20120002,
"nr_add": "",
"date": "2012–03–07",
"expirationdate": "2012–06–05",
"title": "",
"concerning": "Plaatsen van parket in hoeve hotel",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 8,
"address_id": 24,
"address_salutation": "BVBA",
"address_name": "Gasthof Lophem",
"address_address": "Zeedijkweg 23a",
"address_addressline2": "",
"address_latitude": 51.142470000000003,
"address_longitude": 3.18053,
"address_countrycode": "BE",
"address_zipcode": "8210",
"address_city": "Loppem",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "Zeedijkweg 23 A",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 51.142470000000003,
"shippingaddress_longitude": 3.18053,
"shippingaddress_countrycode": "BE",
"shippingaddress_zipcode": "8210",
"shippingaddress_city": "Loppem",
"shippingaddress_state": "West-vlaanderen",
"contact_id": 4,
"contact_salutation": "De Heer",
"contact_name": "Lutters carl",
"vatnr": "BTW BE 0885.429.559",
"gln": "",
"be_rpr": "Brugge",
"telephone1": "+32 50 82 21 67 ",
"telephone2": "",
"fax": "+32 50 40 04 80 ",
"gsm": "",
"email": "carl.lutters@gmail.com",
"project_id": 3,
"project_pnr": 20120003,
"project_unr": 3,
"project_name": "Project: Parketvloeren",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 11108.1200000000008,
"vatcode": "6",
"vatpercent": 6,
"vatamount": 666.490000000000009,
"amountinclvat": 11774.610000000000582,
"basis1": 0.0,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 0.0,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 11108.1200000000008,
"taxableamount3": 11108.1200000000008,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 666.490000000000009,
"amountinclvat3": 11774.610000000000582,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": true,
"approved_date": "2012–03–07",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 11,
"detail_sourcelist": "",
"detail_ordergroups": true,
"ts_lastupdate": "2022–04–28 12:40:30"
},
{
"id": 26,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "OFFERTE",
"type_localized": "OFFER",
"type_id": 1,
"nr": 20120003,
"nr_add": "",
"date": "2012–01–18",
"expirationdate": "2012–04–17",
"title": "",
"concerning": "Art Decoration",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 26,
"address_id": 2685,
"address_salutation": "",
"address_name": "Pestana Chelsea Bridge Hotel",
"address_address": "354 Queenstown Road",
"address_addressline2": "",
"address_latitude": 51.481009999999998,
"address_longitude": –0.1491,
"address_countrycode": "UK",
"address_zipcode": "SW8 4AE",
"address_city": "London",
"address_state": "",
"address_readonly": false,
"shippingaddress_address": "354 Queenstown Road",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 51.481009999999998,
"shippingaddress_longitude": –0.1491,
"shippingaddress_countrycode": "UK",
"shippingaddress_zipcode": "SW8 4AE",
"shippingaddress_city": "London",
"shippingaddress_state": "",
"contact_id": 2,
"contact_salutation": "Miss",
"contact_name": "Suzanne Mellor",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "+44 20 70 62 80 10 ",
"telephone2": "",
"fax": "+44 20 79 78 24 10 ",
"gsm": "",
"email": "Suzanne@pestana.com",
"project_id": 5,
"project_pnr": 20180154,
"project_unr": 4,
"project_name": "Project: Photo Decoration",
"yourreference": "Pestana UK 76993–215",
"be_werkplaatsnr30bis": "",
"basis": 2163.920000000000073,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 2163.920000000000073,
"basis1": 2163.920000000000073,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 2163.920000000000073,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 0.0,
"taxableamount3": 0.0,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 0.0,
"amountinclvat3": 0.0,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": true,
"approved_date": "2012–03–20",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 11,
"detail_sourcelist": "ART GALLERY",
"detail_ordergroups": true,
"ts_lastupdate": "2022–04–28 12:40:30"
}
,
…
]
}
https://ra.bouwsoft.be/api/v1/Orders
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: jDVfWxfmPlzSfGAVIfzRqlbrfGfmfGIlfPIkztlOmAfGVVkPmG
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/7280”,
“Records”:
[
{
"id": 19,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "BESCHERMINGSMIDDELEN",
"type_localized": "MEANS OF PROTECTION",
"type_id": 22,
"nr": 1,
"nr_add": "",
"date": "2012–03–06",
"expirationdate": "2012–03–06",
"title": "",
"concerning": "",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 5,
"address_id": 0,
"address_salutation": "",
"address_name": "Deblauwe Gino",
"address_address": "Gruthof",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "BE",
"address_zipcode": "8490",
"address_city": "Varsenare",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 0,
"shippingaddress_longitude": 0,
"shippingaddress_countrycode": "",
"shippingaddress_zipcode": "",
"shippingaddress_city": "",
"shippingaddress_state": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 0.0,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 0.0,
"basis1": 0.0,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 0.0,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 0.0,
"taxableamount3": 0.0,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 0.0,
"amountinclvat3": 0.0,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": false,
"approved_date": "",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 0,
"detail_sourcelist": "",
"detail_ordergroups": false,
"ts_lastupdate": "2019–10–23 09:50:50"
},
{
"id": 22,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "OFFERTE",
"type_localized": "OFFER",
"type_id": 1,
"nr": 20120002,
"nr_add": "",
"date": "2012–03–07",
"expirationdate": "2012–06–05",
"title": "",
"concerning": "Plaatsen van parket in hoeve hotel",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 8,
"address_id": 24,
"address_salutation": "BVBA",
"address_name": "Gasthof Lophem",
"address_address": "Zeedijkweg 23a",
"address_addressline2": "",
"address_latitude": 51.142470000000003,
"address_longitude": 3.18053,
"address_countrycode": "BE",
"address_zipcode": "8210",
"address_city": "Loppem",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "Zeedijkweg 23 A",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 51.142470000000003,
"shippingaddress_longitude": 3.18053,
"shippingaddress_countrycode": "BE",
"shippingaddress_zipcode": "8210",
"shippingaddress_city": "Loppem",
"shippingaddress_state": "West-vlaanderen",
"contact_id": 4,
"contact_salutation": "De Heer",
"contact_name": "Lutters carl",
"vatnr": "BTW BE 0885.429.559",
"gln": "",
"be_rpr": "Brugge",
"telephone1": "+32 50 82 21 67 ",
"telephone2": "",
"fax": "+32 50 40 04 80 ",
"gsm": "",
"email": "carl.lutters@gmail.com",
"project_id": 3,
"project_pnr": 20120003,
"project_unr": 3,
"project_name": "Project: Parketvloeren",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 11108.1200000000008,
"vatcode": "6",
"vatpercent": 6,
"vatamount": 666.490000000000009,
"amountinclvat": 11774.610000000000582,
"basis1": 0.0,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 0.0,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 11108.1200000000008,
"taxableamount3": 11108.1200000000008,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 666.490000000000009,
"amountinclvat3": 11774.610000000000582,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": true,
"approved_date": "2012–03–07",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 11,
"detail_sourcelist": "",
"detail_ordergroups": true,
"ts_lastupdate": "2022–04–28 12:40:30"
}
,
…
]
}
/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/19
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: AfbfWxfDbVzSfrbrrfzRqGDUfkPkfGbAffbkzDfAjPmGklkIIr
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 19,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "BESCHERMINGSMIDDELEN",
"type_localized": "MEANS OF PROTECTION",
"type_id": 22,
"nr": 1,
"nr_add": "",
"date": "2012–03–06",
"expirationdate": "2012–03–06",
"title": "",
"concerning": "",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 5,
"address_id": 0,
"address_salutation": "",
"address_name": "Deblauwe Gino",
"address_address": "Gruthof",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "BE",
"address_zipcode": "8490",
"address_city": "Varsenare",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 0,
"shippingaddress_longitude": 0,
"shippingaddress_countrycode": "",
"shippingaddress_zipcode": "",
"shippingaddress_city": "",
"shippingaddress_state": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 0.0,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 0.0,
"basis1": 0.0,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 0.0,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 0.0,
"taxableamount3": 0.0,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 0.0,
"amountinclvat3": 0.0,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": false,
"approved_date": "",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 0,
"detail_sourcelist": "",
"detail_ordergroups": false,
"ts_lastupdate": "2019–10–23 09:50:50"
}
]
}
https://ra.bouwsoft.be/api/v1/Orders/19
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GIPfWxfPmOzSfIkIlfzRqfAmfjIAfGOjfjOkzbVmrfmGrGtDDV
Query Parameters :
ParameterName: extratotals, ParameterValue: true
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 19,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "BESCHERMINGSMIDDELEN",
"type_localized": "MEANS OF PROTECTION",
"type_id": 22,
"nr": 1,
"nr_add": "",
"date": "2012–03–06",
"expirationdate": "2012–03–06",
"title": "",
"concerning": "",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 5,
"address_id": 0,
"address_salutation": "",
"address_name": "Deblauwe Gino",
"address_address": "Gruthof",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"address_countrycode": "BE",
"address_zipcode": "8490",
"address_city": "Varsenare",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 0,
"shippingaddress_longitude": 0,
"shippingaddress_countrycode": "",
"shippingaddress_zipcode": "",
"shippingaddress_city": "",
"shippingaddress_state": "",
"contact_id": 0,
"contact_salutation": "",
"contact_name": "",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 0.0,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 0.0,
"basis1": 0.0,
"taxableamount1": 0.0,
"vatcode1": "0",
"vatpercent1": 0,
"vatcocontractor1": false,
"vatamount1": 0.0,
"amountinclvat1": 0.0,
"basis2": 0.0,
"taxableamount2": 0.0,
"vatcode2": "0M",
"vatpercent2": 0,
"vatcocontractor2": true,
"vatamount2": 0.0,
"amountinclvat2": 0.0,
"basis3": 0.0,
"taxableamount3": 0.0,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 0.0,
"amountinclvat3": 0.0,
"basis4": 0.0,
"taxableamount4": 0.0,
"vatcode4": "12",
"vatpercent4": 12.5,
"vatcocontractor4": false,
"vatamount4": 0.0,
"amountinclvat4": 0.0,
"basis5": 0.0,
"taxableamount5": 0.0,
"vatcode5": "21",
"vatpercent5": 21,
"vatcocontractor5": false,
"vatamount5": 0.0,
"amountinclvat5": 0.0,
"cashdiscount_expirationdate": "",
"cashdiscount_percent": 0,
"cashdiscount_amount": 0,
"creditlimitation_expirationdate": "",
"creditlimitation_percent": 0,
"creditlimitation_amount": 0,
"commercialdiscount_percent": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"profit_gross": 0.0,
"profit_gross_percent": 0,
"profit_net": 0.0,
"profit_net_percent": 0,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": false,
"approved_date": "",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 0,
"detail_sourcelist": "",
"detail_ordergroups": false,
"ts_lastupdate": "2019–10–23 09:50:50"
}
]
}
/Orders/{id}/conclusion_html
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/6554/conclusion_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
<HTML><BODY>
<I><DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Century Schoolbook;font-size: 14pt;color: #000000;">ghvfgh<BR>
test als dit slot automatisch ingevuld wordt bij het aanmaken van een factuur vanuit een vorderingsstaat</SPAN></DIV></I>
</BODY></HTML>
/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/6554/conclusion_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: IDmfWxfGVIzSfllkDfzRqVVffbUPGflmfmGbzbtGGfUfGbVtjU
Success gives statuscode 200 And the following result
ghvfgh test als dit slot automatisch ingevuld wordt bij het aanmaken van een factuur vanuit een vorderingsstaat
/Orders/{id}/conclusion_rtf
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/6554/conclusion_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Century Schoolbook;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs28\cf1\i ghvfgh\par test als dit slot automatisch ingevuld wordt bij het aanmaken van een factuur vanuit een vorderingsstaat}
/Orders/{id}/introduction_html
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/6554/introduction_html
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: IDmfWxfGVIzSfllkDfzRqVVffbUPGflmfmGbzbtGGfUfGbVtjU
Success gives statuscode 200 And the following result
<HTML><BODY>
<DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Arial;font-size: 12pt;color: #000000;">a<B></SPAN><SPAN STYLE="font-family: Arial;font-size: 18pt;color: #FF0000;">b</B></SPAN><SPAN STYLE="font-family: Arial;font-size: 12pt;color: #000000;">c</SPAN></DIV>
</BODY></HTML>
/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/6554/introduction_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: IDmfWxfGVIzSfllkDfzRqVVffbUPGflmfmGbzbtGGfUfGbVtjU
Success gives statuscode 200 And the following result
abc
/Orders/{id}/introduction_rtf
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/6554/introduction_rtf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UfDfWxfOPkzSftIAGfzRqVrrfVmOkGrbftAkzbPDAbPIkfDkUb
Success gives statuscode 200 And the following result
{\rtf1\ansi\deff0{\fonttbl{\f0\fnil Arial;}}{\colortbl ;\red0\green0\blue0;\red255\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs24\cf1 a\fs36\cf2\b b\fs24\cf1\b0 c}
/Orders/{id}/pdf
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/pdf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bPlfWxfGtGzSfffOPfzRqbmPfDfVkGAlfkmkzUjbAmGImfDfDb
Success gives statuscode 202 And the following result
{“RecordChanges”:
[
{
"SessionId": 505,
"SessionKey": "B506D3CED9157BB86C02AB40D0E010904B1507C42385E1559D455752F8FDED748E47B8AACF6BC72FD1185DAE0F2D1CDD905101C5CECF6A3006A06359FE58EB45"
}
]
}
https://ra.bouwsoft.be/api/v1/Orders/16124/pdf
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: bPlfWxfGtGzSfffOPfzRqbmPfDfVkGAlfkmkzUjbAmGImfDfDb
Success gives statuscode 202 And the following result
{“RecordChanges”:
[
{
"SessionId": 0,
"SessionKey": "B506D3CED9157BB86C02AB40D0E010904B1507C42385E1559D455752F8FDED748E47B8AACF6BC72FD1185DAE0F2D1CDD905101C5CECF6A3006A06359FE58EB45"
}
]
}