General Description

HTTP method	API version
POST	v1

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

API Path: /Addresses
or
API Path: /Addresses/{id}/Upload

Fields

The following fields are available:

Field Name	Type Id	Type Name	Length	Required	Writeable	Force Write
clientnr	1	tpLong	0	No	Yes	No
suppliernr	1	tpLong	0	No	Yes	No
groups	2	tpString	0	No	No	No
salutation	2	tpString	50	No	Yes	No
language_id	1	tpLong	0	No	Yes	No
name	2	tpString	150	Yes	Yes	No
address	2	tpString	63	No	Yes	No
addressline2	2	tpString	63	No	Yes	No
countrycode	2	tpString	2	No	Yes	No
zipcode	2	tpString	15	No	Yes	No
city	2	tpString	40	No	Yes	No
state	2	tpString	40	No	Yes	No
telephone1	9	tpTelefoon	25	No	Yes	No
telephone2	9	tpTelefoon	25	No	Yes	No
fax	15	tpFax	25	No	Yes	No
gsm	9	tpTelefoon	25	No	Yes	No
shippingaddress_id	1	tpLong	0	No	No	No
shippingaddress_address	2	tpString	63	No	Yes	No
shippingaddress_addressline2	2	tpString	63	No	Yes	No
shippingaddress_countrycode	2	tpString	2	No	Yes	No
shippingaddress_zipcode	2	tpString	15	No	Yes	No
shippingaddress_city	2	tpString	40	No	Yes	No
shippingaddress_state	2	tpString	40	No	Yes	No
email	10	tpEmail	100	No	Yes	No
website	2	tpString	100	No	Yes	No
contact_id	1	tpLong	0	No	Yes	No
project_id	1	tpLong	0	No	Yes	No
vatnr	2	tpString	30	No	Yes	No
vatregistered	5	tpBool	0	No	Yes	No
gln	2	tpString	13	No	Yes	No
be_rpr	2	tpString	50	No	Yes	No
iban1	2	tpString	35	No	Yes	No
bic1	2	tpString	11	No	Yes	No
iban2	2	tpString	35	No	Yes	No
bic2	2	tpString	11	No	Yes	No
term_of_payment	2	tpString	0	No	No	No
date_created	3	tpDate	0	No	No	No
active	5	tpBool	0	No	No	No
risk	5	tpBool	0	No	Yes	No
prospect_datefirstaction	6	tpDateNullString	0	No	Yes	No
prospect_source_id	1	tpLong	0	No	Yes	No
prospect_currentstatus_id	1	tpLong	0	No	Yes	No
ts_lastupdate	3	tpDate	0	No	No	No

/Addresses

API Path: /Addresses/

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: name=’DirkAPICust‘,address=’Molleweg 9’,countrycode=’BE‘,zipcode=’8377’,city=’Meetkerke’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 329298,
    "clientnr": 0,
    "suppliernr": 0,
    "groups": "",
    "salutation": "",
    "language_id": 1,
    "name": "DirkAPICust",
    "address": "Molleweg 9",
    "addressline2": "",
    "countrycode": "BE",
    "zipcode": "8377",
    "city": "Meetkerke",
    "state": "West-vlaanderen",
    "telephone1": "",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "shippingaddress_id": 722949,
    "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": "2026–05–07",
    "active": true,
    "risk": false,
    "prospect_datefirstaction": "",
    "prospect_source_id": 0,
    "prospect_currentstatus_id": 0,
    "ts_lastupdate": "2026–05–07 09:18:22"
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: name=’DirkAPISupp‘,address=’Molleweg 9’,countrycode=’BE‘,zipcode=’8377’,city=’Meetkerke’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 329299,
    "clientnr": 0,
    "suppliernr": 0,
    "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": 722951,
    "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": "2026–05–07",
    "active": true,
    "risk": false,
    "prospect_datefirstaction": "",
    "prospect_source_id": 0,
    "prospect_currentstatus_id": 0,
    "ts_lastupdate": "2026–05–07 09:18:22"
  }
]
}

/Addresses/{id}/Upload

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/329298/Upload

with the following parameters :

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

Body Parameters :
ParameterName: fileParameterValue: tptype.txt

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "name": "tptype.txt",
    "path_display": "",
    "path_lower": "",
    "id": "",
    "client_modified": "2026–05–07T09:18:47Z",
    "server_modified": "2026–05–07T09:18:47Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "Jo/jibWnFPvecjyQn38xoDaL4M++z8eX2Pv/E5pA43c="
  }
]
}