VismaBouwsoftAPICalls.v1_GET_Addresses Method
v1_GET_Addresses() as String

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

HTTP method API version
GET v1

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

API Path: /Addresses/
or
API Path: /Addresses/{id}
or
API Path: /Addresses/{id}/image
or
API Path: /Addresses/{id}/note_html
or
API Path: /Addresses/{id}/note_plain
or
API Path: /Addresses/{id}/note_rtf

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

Fields

The following fields are available:

Field Name Type
id Number
clientnr Number
suppliernr Number
groups String
salutation String
language_id Number
name String
address String
addressline2 String
countrycode String
zipcode String
city String
state String
telephone1 String
telephone2 String
fax String
gsm String
shippingaddress_id Number
shippingaddress_address String
shippingaddress_addressline2 String
shippingaddress_countrycode String
shippingaddress_zipcode String
shippingaddress_city String
shippingaddress_state String
email String
website String
contact_id Number
project_id Number
vatnr String
vatregistered Boolean
gln String
be_rpr String
iban1 String
bic1 String
iban2 String
bic2 String
term_of_payment String
date_created String
active Boolean
risk Boolean
ts_lastupdate String
address_id Number
address_clientnr Number
address_suppliernr Number
address_name String
description String
yourreference String
project_pnr Number
project_unr Number
project_name String
project_address String
project_addressline2 String
project_countrycode String
project_zipcode String
project_city String
project_state String
project_telephone1 String
project_gsm String
project_company_id Number
project_approved Boolean
project_rejected Boolean
project_completed Boolean
project_date_created String
project_date_approved String
project_default Boolean
project_be_werkplaatsnr30bis String

/Addresses/

API Path: /Addresses/

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/Addresses

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: ‘matthias’
ParameterName: limit, ParameterValue: 3

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/13”, “Records”: [
  {
    "id": 15779,
    "clientnr": 1000034,
    "suppliernr": 0,
    "groups": "Matthias",
    "salutation": "Dhr. En Mevr.",
    "language_id": 3,
    "name": "Matthias Bouwsoft",
    "address": "Molenweg 9",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Houtave",
    "state": "West-vlaanderen",
    "telephone1": "+0 000 ",
    "telephone2": "+32 111 11 11 11 11 ",
    "fax": "+32 222 22 22 22 22 ",
    "gsm": "+32 3 333 33 33 33 33 ",
    "shippingaddress_id": 34963,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 26936,
    "project_id": 1027,
    "vatnr": "",
    "vatregistered": false,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2013–11–06",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2022–07–25 11:19:11"
  },
  {
    "id": 167169,
    "clientnr": 20170087,
    "suppliernr": 0,
    "groups": "",
    "salutation": "",
    "language_id": 1,
    "name": "Matthias Bouwsoft",
    "address": "Molenweg 9",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Meetkerke",
    "state": "West-vlaanderen",
    "telephone1": "+32 50 45 40 80 ",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 370990,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 156508,
    "project_id": 2093,
    "vatnr": "",
    "vatregistered": true,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2017–10–05",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2022–07–25 09:46:54"
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: limit, ParameterValue: 3
ParameterName: nextid, ParameterValue: 15848

Success gives statuscode 200 And the following result

{ “Content-Range”:“1642–1644/24960”, “Records”: [
  {
    "id": 15848,
    "clientnr": 1000077,
    "suppliernr": 0,
    "groups": "Bedrijven",
    "salutation": "De Heer",
    "language_id": 1,
    "name": "Matthias Vienne",
    "address": "veld 11",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8200",
    "city": "Sint-Michiels (Brugge)",
    "state": "West-Vlaanderen",
    "telephone1": "+32 49 45 66 43 ",
    "telephone2": "+32 50 76 64 69 ",
    "fax": "+32 50 67 64 69 ",
    "gsm": "",
    "shippingaddress_id": 36472,
    "shippingaddress_address": "Molenweg 9",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "BE",
    "shippingaddress_zipcode": "8377",
    "shippingaddress_city": "Meetkerke",
    "shippingaddress_state": "West-vlaanderen",
    "email": "",
    "website": "http://www.matthias-vienne.be",
    "contact_id": 12129,
    "project_id": 866,
    "vatnr": "",
    "vatregistered": false,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2014–01–24",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2022–07–25 09:46:59"
  },
  {
    "id": 168243,
    "clientnr": 20180135,
    "suppliernr": 0,
    "groups": "",
    "salutation": "",
    "language_id": 1,
    "name": "Matthias Vienne (Use It Group)",
    "address": "",
    "addressline2": "",
    "countrycode": "",
    "zipcode": "",
    "city": "",
    "state": "",
    "telephone1": "",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 396009,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 0,
    "project_id": 0,
    "vatnr": "",
    "vatregistered": true,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2018–10–29",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2022–07–25 09:47:00"
  }
,
…
]
}

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/24961”, “Records”: [
  {
    "id": 13,
    "clientnr": 0,
    "suppliernr": 4,
    "groups": "",
    "salutation": "NV",
    "language_id": 1,
    "name": "Philips Bert Bertmans",
    "address": "Pompstraat 5",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8400",
    "city": "Oostende",
    "state": "West-vlaanderen",
    "telephone1": "+32 59 11 22 33 ",
    "telephone2": "",
    "fax": "+32 56 41 79 76 ",
    "gsm": "+32 466 66 66 66 ",
    "shippingaddress_id": 699814,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "flaaares@hotmail.com",
    "website": "http://www.w-v-s.be",
    "contact_id": 0,
    "project_id": 0,
    "vatnr": "BE0466.415.194",
    "vatregistered": true,
    "gln": "",
    "be_rpr": "",
    "iban1": "BE54652806624497",
    "bic1": "BRUBBBBB",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2012–09–04",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2024–03–25 15:13:20"
  },
  {
    "id": 17,
    "clientnr": 0,
    "suppliernr": 7,
    "groups": "",
    "salutation": "NV",
    "language_id": 1,
    "name": "Heumatop",
    "address": "Heiweg 1",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "2260",
    "city": "Westerlo",
    "state": "Antwerpen",
    "telephone1": "",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 0,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 0,
    "project_id": 0,
    "vatnr": "",
    "vatregistered": false,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2012–09–04",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2020–11–26 09:03:43"
  }
,
…
]
}

/Addresses/{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/Addresses/328891

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 328891,
    "clientnr": 201700448,
    "suppliernr": 0,
    "groups": "",
    "salutation": "",
    "language_id": 1,
    "name": "DirkAPICust",
    "address": "Molleweg 9",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Houtave",
    "state": "West-vlaanderen",
    "telephone1": "",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 710772,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 0,
    "project_id": 0,
    "vatnr": "",
    "vatregistered": true,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2025–02–12",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2025–02–12 14:25:50"
  }
]
}

https://ra.bouwsoft.be/api/v1/Addresses/328892

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 328892,
    "clientnr": 0,
    "suppliernr": 201700451,
    "groups": "",
    "salutation": "",
    "language_id": 1,
    "name": "DirkAPISupp",
    "address": "Molleweg 9",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Meetkerke",
    "state": "West-vlaanderen",
    "telephone1": "",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 710774,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "email": "",
    "website": "",
    "contact_id": 0,
    "project_id": 0,
    "vatnr": "",
    "vatregistered": true,
    "gln": "",
    "be_rpr": "",
    "iban1": "",
    "bic1": "",
    "iban2": "",
    "bic2": "",
    "term_of_payment": "30 days",
    "date_created": "2025–02–12",
    "active": true,
    "risk": false,
    "ts_lastupdate": "2025–02–12 14:25:44"
  }
]
}

/Addresses/{id}/image

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/Addresses/3759/image

with the following parameters :

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

Success gives statuscode 200 And the following result

image

/Addresses/{id}/note_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/Addresses/3759/note_html

with the following parameters :

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

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>B</B>c</SPAN></DIV> </BODY></HTML>

/Addresses/{id}/note_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/Addresses/3759/note_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

aBc

/Addresses/{id}/note_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/Addresses/3759/note_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;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs24\cf1 a\b B\b0 c}