| VismaBouwsoftAPICalls.v1_POST_PurchaseInvoices | Method |
This API call is used to add a(n) PurchaseInvoice
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 Name | Length | Required | Writeable | Force Write | Link |
|---|---|---|---|---|---|---|
| company_id | tpLong | 0 | No | Yes | No | |
| nr | tpLong | 0 | No | Yes | No | |
| date | tpDate | 0 | No | Yes | No | |
| expirationdate | tpDate | 0 | No | Yes | No | |
| nr_supplier | tpString | 100 | No | Yes | No | |
| concerning | tpString | 250 | No | Yes | No | |
| paymentnotification | tpString | 200 | No | Yes | No | |
| ledger | tpLong | 0 | No | Yes | No | |
| depreciation | tpDouble | 0 | No | Yes | No | |
| accountnumber | tpString | 30 | No | Yes | No | |
| address_id | tpLong | 0 | No | Yes | No | |
| address_name | tpString | 150 | No | Yes | No | |
| address_address | tpString | 63 | No | Yes | No | |
| address_addressline2 | tpString | 63 | No | No | No | |
| address_countrycode | tpString | 2 | No | Yes | No | |
| address_zipcode | tpString | 15 | No | Yes | No | |
| address_vatnr | tpString | 30 | No | Yes | No | |
| commercialdiscount | tpDouble | 0 | No | Yes | No | |
| cashdiscount | tpDouble | 0 | No | Yes | No | |
| cashdiscount_amount | tpCurrency | 0 | No | Yes | No | |
| cashdiscount_approved | tpBool | 0 | No | Yes | No | |
| basis1 | tpCurrency | 0 | No | Yes | No | |
| vatid1 | tpLong | 0 | No | Yes | No | |
| vatcode1 | tpString | 5 | No | Yes | No | |
| vatpercent1 | tpDouble | 0 | No | Yes | No | |
| vatcocontractor1 | tpBool | 0 | No | Yes | No | |
| amountexclvat1 | tpCurrency | 0 | No | No | No | |
| taxableamount1 | tpCurrency | 0 | No | No | No | |
| vatamount1 | tpCurrency | 0 | No | No | No | |
| amountinclvat1 | tpCurrency | 0 | No | No | No | |
| basis2 | tpCurrency | 0 | No | Yes | No | |
| vatid2 | tpLong | 0 | No | Yes | No | |
| vatcode2 | tpString | 5 | No | Yes | No | |
| vatpercent2 | tpDouble | 0 | No | Yes | No | |
| vatcocontractor2 | tpBool | 0 | No | Yes | No | |
| amountexclvat2 | tpCurrency | 0 | No | No | No | |
| taxableamount2 | tpCurrency | 0 | No | No | No | |
| vatamount2 | tpCurrency | 0 | No | No | No | |
| amountinclvat2 | tpCurrency | 0 | No | No | No | |
| basis3 | tpCurrency | 0 | No | Yes | No | |
| vatid3 | tpLong | 0 | No | Yes | No | |
| vatcode3 | tpString | 5 | No | Yes | No | |
| vatpercent3 | tpDouble | 0 | No | Yes | No | |
| vatcocontractor3 | tpBool | 0 | No | Yes | No | |
| amountexclvat3 | tpCurrency | 0 | No | No | No | |
| taxableamount3 | tpCurrency | 0 | No | No | No | |
| vatamount3 | tpCurrency | 0 | No | No | No | |
| amountinclvat3 | tpCurrency | 0 | No | No | No | |
| basis4 | tpCurrency | 0 | No | Yes | No | |
| vatid4 | tpLong | 0 | No | Yes | No | |
| vatcode4 | tpString | 5 | No | Yes | No | |
| vatpercent4 | tpDouble | 0 | No | Yes | No | |
| vatcocontractor4 | tpBool | 0 | No | Yes | No | |
| amountexclvat4 | tpCurrency | 0 | No | No | No | |
| taxableamount4 | tpCurrency | 0 | No | No | No | |
| vatamount4 | tpCurrency | 0 | No | No | No | |
| amountinclvat4 | tpCurrency | 0 | No | No | No | |
| basis5 | tpCurrency | 0 | No | Yes | No | |
| vatid5 | tpLong | 0 | No | Yes | No | |
| vatcode5 | tpString | 5 | No | Yes | No | |
| vatpercent5 | tpDouble | 0 | No | Yes | No | |
| vatcocontractor5 | tpBool | 0 | No | Yes | No | |
| amountexclvat5 | tpCurrency | 0 | No | No | No | |
| taxableamount5 | tpCurrency | 0 | No | No | No | |
| vatamount5 | tpCurrency | 0 | No | No | No | |
| amountinclvat5 | tpCurrency | 0 | No | No | No | |
| totalsbasedonvatcodebreakdown | tpBool | 0 | No | No | No | |
| amountexclvat_total | tpCurrency | 0 | No | Yes | No | |
| vatamount_total | tpCurrency | 0 | No | Yes | No | |
| amountinclvat_total | tpCurrency | 0 | No | No | No | |
| paid | tpBool | 0 | No | Yes | No | |
| amountoutstanding | tpCurrency | 0 | No | No | No | |
| amountpaid | tpCurrency | 0 | No | No | No | |
| ts_lastupdate | tpDate | 0 | No | No | No |
/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: AccessToken, ParameterValue: trbfWxfkIOzSfGPDktzRqOVbftGVIOmOjDjtzmmDttjGfDlVGl
ParameterName: Clientnr, ParameterValue: 115
Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=329298,date=’2017–04–20’
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 935,
"company_id": 1,
"nr": 202000140,
"date": "2017–04–20",
"expirationdate": "2017–05–20",
"nr_supplier": "",
"concerning": "",
"paymentnotification": "",
"ledger": 0,
"depreciation": 100,
"accountnumber": "",
"address_id": 329298,
"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": 11,
"vatcode5": "19FR",
"vatpercent5": 19,
"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": "2026–04–08 08:40:25"
}
]
}
https://ra.bouwsoft.be/api/v1/PurchaseInvoices
with the following parameters :
Header Parameters :
ParameterName: AccessToken, ParameterValue: jmrfWxfmIfzSfDkVjtzRqODUfIUjIOtAjtVtzGbjIbbGAOUOGU
ParameterName: Clientnr, ParameterValue: 115
Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=329298,date=’2017–04–20’,basis1=100
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 935,
"company_id": 1,
"nr": 202000140,
"date": "2017–04–20",
"expirationdate": "2017–05–20",
"nr_supplier": "",
"concerning": "",
"paymentnotification": "",
"ledger": 0,
"depreciation": 100,
"accountnumber": "",
"address_id": 329298,
"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": 11,
"vatcode5": "19FR",
"vatpercent5": 19,
"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": "2026–04–08 08:47:57"
}
]
}
https://ra.bouwsoft.be/api/v1/PurchaseInvoices
with the following parameters :
Header Parameters :
ParameterName: AccessToken, ParameterValue: jmrfWxfmIfzSfDkVjtzRqODUfIUjIOtAjtVtzGbjIbbGAOUOGU
ParameterName: Clientnr, ParameterValue: 115
Query Parameters :
ParameterName: columns, ParameterValue: company_id=1,address_id=329298,date=’2017–04–20’,amountexclvat_total=100,vatamount_total=21
Success gives statuscode 201 And the following result
{“RecordChanges”:
[
{
"id": 936,
"company_id": 1,
"nr": 202000141,
"date": "2017–04–20",
"expirationdate": "2017–05–20",
"nr_supplier": "",
"concerning": "",
"paymentnotification": "",
"ledger": 0,
"depreciation": 100,
"accountnumber": "",
"address_id": 329298,
"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": 11,
"vatcode5": "19FR",
"vatpercent5": 19,
"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": "2026–04–08 08:47:59"
}
]
}
/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/935/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": "2026–04–08T08:40:27Z",
"server_modified": "2026–04–08T08:40:27Z",
"rev": "",
"size": 425,
"is_downloadable": true,
"checksum": "7LA8LmP23e5vaEEeU3zEoQgF6qhDANWRO2WRRBRerSI="
}
]
}