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	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
path_display	String
path_lower	String
client_modified	String
server_modified	String
rev	String
size	Number
is_downloadable	Boolean
checksum	String

/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: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VmkfWxfGIlzSftDGrfzRqbIrfAAUkGtmflmkzkIOlVjIPmUPGA

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": 328891,
    "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": 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:41"
  }
]
}

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

with the following parameters :

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

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": 328892,
    "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": 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:43"
  }
]
}

/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/328891/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": "2025–02–12T14:26:28Z",
    "server_modified": "2025–02–12T14:26:28Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "kfv3OEGj6tkIuFIHJbzA4ogGUupmqEhhBAhrcxq3Vt0="
  }
]
}