General Description

HTTP method	API version
POST	v1

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

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

Fields

The following fields are available:

Field Name	Type
id	Number
company_id	Number
nr	Number
date	String
expirationdate	String
nr_supplier	String
concerning	String
paymentnotification	String
ledger	Number
depreciation	Number
accountnumber	String
address_id	Number
address_name	String
address_address	String
address_addressline2	String
address_countrycode	String
address_zipcode	String
address_city	String
address_vatnr	String
commercialdiscount	Number
cashdiscount	Number
cashdiscount_amount	Number
cashdiscount_approved	Boolean
basis1	Number
vatid1	Number
vatcode1	String
vatpercent1	Number
vatcocontractor1	Boolean
amountexclvat1	Number
taxableamount1	Number
vatamount1	Number
amountinclvat1	Number
basis2	Number
vatid2	Number
vatcode2	String
vatpercent2	Number
vatcocontractor2	Boolean
amountexclvat2	Number
taxableamount2	Number
vatamount2	Number
amountinclvat2	Number
basis3	Number
vatid3	Number
vatcode3	String
vatpercent3	Number
vatcocontractor3	Boolean
amountexclvat3	Number
taxableamount3	Number
vatamount3	Number
amountinclvat3	Number
basis4	Number
vatid4	Number
vatcode4	String
vatpercent4	Number
vatcocontractor4	Boolean
amountexclvat4	Number
taxableamount4	Number
vatamount4	Number
amountinclvat4	Number
basis5	Number
vatid5	Number
vatcode5	String
vatpercent5	Number
vatcocontractor5	Boolean
amountexclvat5	Number
taxableamount5	Number
vatamount5	Number
amountinclvat5	Number
totalsbasedonvatcodebreakdown	Boolean
amountexclvat_total	Number
vatamount_total	Number
amountinclvat_total	Number
paid	Boolean
amountoutstanding	Number
amountpaid	Number
ts_lastupdate	String
name	String
path_display	String
path_lower	String
client_modified	String
server_modified	String
rev	String
size	Number
is_downloadable	Boolean
checksum	String

/PurchaseInvoices

API Path: /PurchaseInvoices/

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=328892,date=’2017–04–20’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 884,
    "company_id": 1,
    "nr": 202000122,
    "date": "2017–04–20",
    "expirationdate": "2017–05–20",
    "nr_supplier": "",
    "concerning": "",
    "paymentnotification": "",
    "ledger": 0,
    "depreciation": 100,
    "accountnumber": "",
    "address_id": 328892,
    "address_name": "DirkAPISupp",
    "address_address": "Molleweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "address_vatnr": "",
    "commercialdiscount": 0,
    "cashdiscount": 0,
    "cashdiscount_amount": 0.0,
    "cashdiscount_approved": false,
    "basis1": 0.0,
    "vatid1": 7,
    "vatcode1": "21",
    "vatpercent1": 21,
    "vatcocontractor1": false,
    "amountexclvat1": 0.0,
    "taxableamount1": 0.0,
    "vatamount1": 0.0,
    "amountinclvat1": 0.0,
    "basis2": 0.0,
    "vatid2": 23,
    "vatcode2": "21B",
    "vatpercent2": 21,
    "vatcocontractor2": false,
    "amountexclvat2": 0.0,
    "taxableamount2": 0.0,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 0.0,
    "vatid3": 8,
    "vatcode3": "21M",
    "vatpercent3": 21,
    "vatcocontractor3": true,
    "amountexclvat3": 0.0,
    "taxableamount3": 0.0,
    "vatamount3": 0.0,
    "amountinclvat3": 0.0,
    "basis4": 0.0,
    "vatid4": 28,
    "vatcode4": "6B",
    "vatpercent4": 6,
    "vatcocontractor4": false,
    "amountexclvat4": 0.0,
    "taxableamount4": 0.0,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 0.0,
    "vatid5": 1,
    "vatcode5": "0",
    "vatpercent5": 0,
    "vatcocontractor5": false,
    "amountexclvat5": 0.0,
    "taxableamount5": 0.0,
    "vatamount5": 0.0,
    "amountinclvat5": 0.0,
    "totalsbasedonvatcodebreakdown": false,
    "amountexclvat_total": 0.0,
    "vatamount_total": 0.0,
    "amountinclvat_total": 0.0,
    "paid": false,
    "amountoutstanding": 0.0,
    "amountpaid": 0.0,
    "ts_lastupdate": "2025–02–12 14:28:54"
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=328892,date=’2017–04–20’,basis1=100

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 884,
    "company_id": 1,
    "nr": 202000122,
    "date": "2017–04–20",
    "expirationdate": "2017–05–20",
    "nr_supplier": "",
    "concerning": "",
    "paymentnotification": "",
    "ledger": 0,
    "depreciation": 100,
    "accountnumber": "",
    "address_id": 328892,
    "address_name": "DirkAPISupp",
    "address_address": "Molleweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "address_vatnr": "",
    "commercialdiscount": 0,
    "cashdiscount": 0,
    "cashdiscount_amount": 0.0,
    "cashdiscount_approved": false,
    "basis1": 100.0,
    "vatid1": 7,
    "vatcode1": "21",
    "vatpercent1": 21,
    "vatcocontractor1": false,
    "amountexclvat1": 100.0,
    "taxableamount1": 100.0,
    "vatamount1": 21.0,
    "amountinclvat1": 121.0,
    "basis2": 0.0,
    "vatid2": 23,
    "vatcode2": "21B",
    "vatpercent2": 21,
    "vatcocontractor2": false,
    "amountexclvat2": 0.0,
    "taxableamount2": 0.0,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 0.0,
    "vatid3": 8,
    "vatcode3": "21M",
    "vatpercent3": 21,
    "vatcocontractor3": true,
    "amountexclvat3": 0.0,
    "taxableamount3": 0.0,
    "vatamount3": 0.0,
    "amountinclvat3": 0.0,
    "basis4": 0.0,
    "vatid4": 28,
    "vatcode4": "6B",
    "vatpercent4": 6,
    "vatcocontractor4": false,
    "amountexclvat4": 0.0,
    "taxableamount4": 0.0,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 0.0,
    "vatid5": 1,
    "vatcode5": "0",
    "vatpercent5": 0,
    "vatcocontractor5": false,
    "amountexclvat5": 0.0,
    "taxableamount5": 0.0,
    "vatamount5": 0.0,
    "amountinclvat5": 0.0,
    "totalsbasedonvatcodebreakdown": true,
    "amountexclvat_total": 100.0,
    "vatamount_total": 21.0,
    "amountinclvat_total": 121.0,
    "paid": true,
    "amountoutstanding": 121.0,
    "amountpaid": 0.0,
    "ts_lastupdate": "2025–02–12 14:34:49"
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=328892,date=’2017–04–20’,amountexclvat_total=100,vatamount_total=21

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 885,
    "company_id": 1,
    "nr": 202000123,
    "date": "2017–04–20",
    "expirationdate": "2017–05–20",
    "nr_supplier": "",
    "concerning": "",
    "paymentnotification": "",
    "ledger": 0,
    "depreciation": 100,
    "accountnumber": "",
    "address_id": 328892,
    "address_name": "DirkAPISupp",
    "address_address": "Molleweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Meetkerke",
    "address_vatnr": "",
    "commercialdiscount": 0,
    "cashdiscount": 0,
    "cashdiscount_amount": 0.0,
    "cashdiscount_approved": false,
    "basis1": 0.0,
    "vatid1": 7,
    "vatcode1": "21",
    "vatpercent1": 21,
    "vatcocontractor1": false,
    "amountexclvat1": 0.0,
    "taxableamount1": 0.0,
    "vatamount1": 0.0,
    "amountinclvat1": 0.0,
    "basis2": 0.0,
    "vatid2": 23,
    "vatcode2": "21B",
    "vatpercent2": 21,
    "vatcocontractor2": false,
    "amountexclvat2": 0.0,
    "taxableamount2": 0.0,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 0.0,
    "vatid3": 8,
    "vatcode3": "21M",
    "vatpercent3": 21,
    "vatcocontractor3": true,
    "amountexclvat3": 0.0,
    "taxableamount3": 0.0,
    "vatamount3": 0.0,
    "amountinclvat3": 0.0,
    "basis4": 0.0,
    "vatid4": 28,
    "vatcode4": "6B",
    "vatpercent4": 6,
    "vatcocontractor4": false,
    "amountexclvat4": 0.0,
    "taxableamount4": 0.0,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 0.0,
    "vatid5": 1,
    "vatcode5": "0",
    "vatpercent5": 0,
    "vatcocontractor5": false,
    "amountexclvat5": 0.0,
    "taxableamount5": 0.0,
    "vatamount5": 0.0,
    "amountinclvat5": 0.0,
    "totalsbasedonvatcodebreakdown": false,
    "amountexclvat_total": 100.0,
    "vatamount_total": 21.0,
    "amountinclvat_total": 121.0,
    "paid": true,
    "amountoutstanding": 121.0,
    "amountpaid": 0.0,
    "ts_lastupdate": "2025–02–12 14:34:50"
  }
]
}

/PurchaseInvoices/{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/PurchaseInvoices/884/Upload

with the following parameters :

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

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