VismaBouwsoftAPICalls.v1_GET_SalesInvoices

Method

v1_GET_SalesInvoices() as String

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

HTTP method	API version
GET	v1

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

API Path: /SalesInvoices/
or
API Path: /SalesInvoices/{id}
or
API Path: /SalesInvoices/{id}/conclusion_html
or
API Path: /SalesInvoices/{id}/conclusion_plain
or
API Path: /SalesInvoices/{id}/conclusion_rtf
or
API Path: /SalesInvoices/{id}/introduction_html
or
API Path: /SalesInvoices/{id}/introduction_plain
or
API Path: /SalesInvoices/{id}/introduction_rtf

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

Fields

The following fields are available:

Field Name	Type
id	Number
company_id	Number
company_name	String
type	String
type_localized	String
type_id	Number
nr	Number
nr_add	String
date	String
expirationdate	String
title	String
concerning	String
chargeableevent	String
senttoaccountingsoftware	Boolean
senttoaccountingsoftware_ts	String
structuredpaymentnotification	String
ordernr	String
pricedecimals	Number
ledger	Number
workingdocumentdata_id	Number
address_id	Number
address_salutation	String
address_name	String
address_address	String
address_addressline2	String
address_latitude	Number
address_longitude	Number
address_countrycode	String
address_zipcode	String
address_city	String
address_state	String
address_readonly	Boolean
shippingaddress_address	String
shippingaddress_addressline2	String
shippingaddress_latitude	Number
shippingaddress_longitude	Number
shippingaddress_countrycode	String
shippingaddress_zipcode	String
shippingaddress_city	String
shippingaddress_state	String
contact_id	Number
contact_salutation	String
contact_name	String
vatnr	String
gln	String
be_rpr	String
telephone1	String
telephone2	String
fax	String
gsm	String
email	String
project_id	Number
project_pnr	Number
project_unr	Number
project_name	String
yourreference	String
be_werkplaatsnr30bis	String
basis	Number
vatcode	String
vatpercent	Number
vatamount	Number
amountinclvat	Number
basis1	Number
taxableamount1	Number
vatcode1	String
vatpercent1	Number
vatcocontractor1	Boolean
vatamount1	Number
amountinclvat1	Number
basis2	Number
taxableamount2	Number
vatcode2	String
vatpercent2	Number
vatcocontractor2	Boolean
vatamount2	Number
amountinclvat2	Number
basis3	Number
taxableamount3	Number
vatcode3	String
vatpercent3	Number
vatcocontractor3	Boolean
vatamount3	Number
amountinclvat3	Number
basis4	Number
taxableamount4	Number
vatcode4	String
vatpercent4	Number
vatcocontractor4	Boolean
vatamount4	Number
amountinclvat4	Number
basis5	Number
taxableamount5	Number
vatcode5	String
vatpercent5	Number
vatcocontractor5	Boolean
vatamount5	Number
amountinclvat5	Number
cashdiscount_expirationdate	String
cashdiscount_percent	Number
cashdiscount_amount	Number
creditlimitation_expirationdate	String
creditlimitation_percent	Number
creditlimitation_amount	Number
commercialdiscount_percent	Number
distributeddiscount_amount	Number
include_commission_in_total	Boolean
advance	Number
balance	Number
locked	Boolean
createdby	String
lasteditedby	String
approved	Boolean
approved_date	String
rejected	Boolean
rejected_date	String
verified	Boolean
sent	Boolean
sent_date	String
signed	Boolean
billed	Boolean
detail_source	Number
detail_sourcelist	String
detail_ordergroups	Boolean
ts_lastupdate	String

/SalesInvoices/

API Path: /SalesInvoices/

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/3412”, “Records”: [
  {
    "id": 24,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "type": "FAKTUUR",
    "type_localized": "INVOICE",
    "type_id": 4,
    "nr": 20120002,
    "nr_add": "",
    "date": "2012–03–08",
    "expirationdate": "2012–03–16",
    "title": "",
    "concerning": "Leveren van parket: Bijbestelling",
    "chargeableevent": "2012–03–08",
    "senttoaccountingsoftware": true,
    "senttoaccountingsoftware_ts": "",
    "structuredpaymentnotification": "",
    "ordernr": "",
    "pricedecimals": 2,
    "ledger": 70000,
    "workingdocumentdata_id": 14,
    "address_id": 40681,
    "address_salutation": "",
    "address_name": "Iserbyt",
    "address_address": "Stefaniestraat 48",
    "address_addressline2": "",
    "address_latitude": 0,
    "address_longitude": 0,
    "address_countrycode": "BE",
    "address_zipcode": "2018",
    "address_city": "Antwerpen 1",
    "address_state": "Antwerpen",
    "address_readonly": false,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_latitude": 0,
    "shippingaddress_longitude": 0,
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "contact_id": 0,
    "contact_salutation": "",
    "contact_name": "",
    "vatnr": "",
    "gln": "",
    "be_rpr": "",
    "telephone1": "+32 3 237 74 63 ",
    "telephone2": "",
    "fax": "",
    "gsm": "+32 476 33 59 73 ",
    "email": "",
    "project_id": 0,
    "project_pnr": 0,
    "project_unr": 0,
    "project_name": "",
    "yourreference": "",
    "be_werkplaatsnr30bis": "",
    "basis": 165.0,
    "vatcode": "21",
    "vatpercent": 21,
    "vatamount": 34.649999999999999,
    "amountinclvat": 199.650000000000006,
    "basis1": 0.0,
    "taxableamount1": 0.0,
    "vatcode1": "0",
    "vatpercent1": 0,
    "vatcocontractor1": false,
    "vatamount1": 0.0,
    "amountinclvat1": 0.0,
    "basis2": 0.0,
    "taxableamount2": 0.0,
    "vatcode2": "0M",
    "vatpercent2": 0,
    "vatcocontractor2": true,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 0.0,
    "taxableamount3": 0.0,
    "vatcode3": "6",
    "vatpercent3": 6,
    "vatcocontractor3": false,
    "vatamount3": 0.0,
    "amountinclvat3": 0.0,
    "basis4": 0.0,
    "taxableamount4": 0.0,
    "vatcode4": "12",
    "vatpercent4": 12.5,
    "vatcocontractor4": false,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 165.0,
    "taxableamount5": 0.0,
    "vatcode5": "21",
    "vatpercent5": 21,
    "vatcocontractor5": false,
    "vatamount5": 34.649999999999999,
    "amountinclvat5": 199.650000000000006,
    "cashdiscount_expirationdate": "",
    "cashdiscount_percent": 0,
    "cashdiscount_amount": 0,
    "creditlimitation_expirationdate": "",
    "creditlimitation_percent": 0,
    "creditlimitation_amount": 0,
    "commercialdiscount_percent": 0,
    "distributeddiscount_amount": 0,
    "include_commission_in_total": true,
    "advance": 0.0,
    "balance": –1105.690000000000055,
    "locked": false,
    "createdby": "",
    "lasteditedby": "",
    "approved": false,
    "approved_date": "",
    "rejected": false,
    "rejected_date": "",
    "verified": false,
    "sent": false,
    "sent_date": "",
    "signed": false,
    "billed": false,
    "detail_source": 11,
    "detail_sourcelist": "PARKET",
    "detail_ordergroups": false,
    "ts_lastupdate": "2019–11–26 09:43:03"
  },
  {
    "id": 25,
    "company_id": 1,
    "company_name": "Bouwsoft",
    "type": "FAKTUUR",
    "type_localized": "INVOICE",
    "type_id": 4,
    "nr": 20120003,
    "nr_add": "",
    "date": "2012–03–08",
    "expirationdate": "2020–12–25",
    "title": "",
    "concerning": "Leveren van verf",
    "chargeableevent": "2012–03–08",
    "senttoaccountingsoftware": false,
    "senttoaccountingsoftware_ts": "",
    "structuredpaymentnotification": "",
    "ordernr": "",
    "pricedecimals": 2,
    "ledger": 70000,
    "workingdocumentdata_id": 15,
    "address_id": 1930,
    "address_salutation": "",
    "address_name": "SABBE BEDRIJF",
    "address_address": "HOUTHULSTSTRAAT 76",
    "address_addressline2": "",
    "address_latitude": 0,
    "address_longitude": 0,
    "address_countrycode": "BE",
    "address_zipcode": "8840",
    "address_city": "Staden",
    "address_state": "West-Vlaanderen",
    "address_readonly": false,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_latitude": 0,
    "shippingaddress_longitude": 0,
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "contact_id": 0,
    "contact_salutation": "",
    "contact_name": "",
    "vatnr": "BE 0427.257.581",
    "gln": "",
    "be_rpr": "",
    "telephone1": "+32 51 70 81 38 ",
    "telephone2": "",
    "fax": "",
    "gsm": "",
    "email": "info@sabbebvba.be",
    "project_id": 0,
    "project_pnr": 0,
    "project_unr": 0,
    "project_name": "",
    "yourreference": "",
    "be_werkplaatsnr30bis": "",
    "basis": 4571.399999999999636,
    "vatcode": "21",
    "vatpercent": 21,
    "vatamount": 274.279999999999973,
    "amountinclvat": 4845.680000000000291,
    "basis1": 0.0,
    "taxableamount1": 0.0,
    "vatcode1": "0",
    "vatpercent1": 0,
    "vatcocontractor1": false,
    "vatamount1": 0.0,
    "amountinclvat1": 0.0,
    "basis2": 0.0,
    "taxableamount2": 0.0,
    "vatcode2": "0M",
    "vatpercent2": 0,
    "vatcocontractor2": true,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 4571.399999999999636,
    "taxableamount3": 4571.399999999999636,
    "vatcode3": "6",
    "vatpercent3": 6,
    "vatcocontractor3": false,
    "vatamount3": 274.279999999999973,
    "amountinclvat3": 4845.680000000000291,
    "basis4": 0.0,
    "taxableamount4": 0.0,
    "vatcode4": "12",
    "vatpercent4": 12.5,
    "vatcocontractor4": false,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 0.0,
    "taxableamount5": 0.0,
    "vatcode5": "21",
    "vatpercent5": 21,
    "vatcocontractor5": false,
    "vatamount5": 0.0,
    "amountinclvat5": 0.0,
    "cashdiscount_expirationdate": "",
    "cashdiscount_percent": 0,
    "cashdiscount_amount": 0,
    "creditlimitation_expirationdate": "",
    "creditlimitation_percent": 0,
    "creditlimitation_amount": 0,
    "commercialdiscount_percent": 10,
    "distributeddiscount_amount": 0,
    "include_commission_in_total": true,
    "advance": 0.0,
    "balance": 4745.680000000000291,
    "locked": false,
    "createdby": "",
    "lasteditedby": "DIRK",
    "approved": true,
    "approved_date": "2024–07–15",
    "rejected": false,
    "rejected_date": "",
    "verified": false,
    "sent": true,
    "sent_date": "2023–04–17",
    "signed": false,
    "billed": false,
    "detail_source": 11,
    "detail_sourcelist": "VERF",
    "detail_ordergroups": true,
    "ts_lastupdate": "2025–02–12 14:29:54"
  }
,
…
]
}

/SalesInvoices/{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/SalesInvoices/16126

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 16126,
    "company_id": 2,
    "company_name": "Groensoft",
    "type": "FAKTUUR",
    "type_localized": "INVOICE",
    "type_id": 4,
    "nr": 202400099,
    "nr_add": "",
    "date": "2025–02–12",
    "expirationdate": "2025–02–22",
    "title": "",
    "concerning": "",
    "chargeableevent": "2025–02–12",
    "senttoaccountingsoftware": false,
    "senttoaccountingsoftware_ts": "",
    "structuredpaymentnotification": "000001612624",
    "ordernr": "",
    "pricedecimals": 2,
    "ledger": 700210,
    "workingdocumentdata_id": 30534,
    "address_id": 3759,
    "address_salutation": "B.V.",
    "address_name": "Spikesoft",
    "address_address": "Gruuthof 23",
    "address_addressline2": "",
    "address_latitude": 51.191470000000002,
    "address_longitude": 3.15141,
    "address_countrycode": "BE",
    "address_zipcode": "8490",
    "address_city": "Varsenare",
    "address_state": "West-vlaanderen",
    "address_readonly": false,
    "shippingaddress_address": "",
    "shippingaddress_addressline2": "",
    "shippingaddress_latitude": 0,
    "shippingaddress_longitude": 0,
    "shippingaddress_countrycode": "",
    "shippingaddress_zipcode": "",
    "shippingaddress_city": "",
    "shippingaddress_state": "",
    "contact_id": 32334,
    "contact_salutation": "B.V.",
    "contact_name": "Gino Deblauwe",
    "vatnr": "BE 0722 772 536",
    "gln": "",
    "be_rpr": "",
    "telephone1": "+32 486 60 64 21 ",
    "telephone2": "",
    "fax": "+32 50 45 40 80 ",
    "gsm": "+32 486 60 64 09",
    "email": "gino@bouwsoft.be",
    "project_id": 955,
    "project_pnr": 20170184,
    "project_unr": 2018005,
    "project_name": "Warmtepomp plaatsen",
    "yourreference": "testingref",
    "be_werkplaatsnr30bis": "",
    "basis": 0.0,
    "vatcode": "21",
    "vatpercent": 21,
    "vatamount": 0.0,
    "amountinclvat": 0.0,
    "basis1": 0.0,
    "taxableamount1": 0.0,
    "vatcode1": "21",
    "vatpercent1": 21,
    "vatcocontractor1": false,
    "vatamount1": 0.0,
    "amountinclvat1": 0.0,
    "basis2": 0.0,
    "taxableamount2": 0.0,
    "vatcode2": "21B",
    "vatpercent2": 21,
    "vatcocontractor2": false,
    "vatamount2": 0.0,
    "amountinclvat2": 0.0,
    "basis3": 0.0,
    "taxableamount3": 0.0,
    "vatcode3": "21M",
    "vatpercent3": 21,
    "vatcocontractor3": true,
    "vatamount3": 0.0,
    "amountinclvat3": 0.0,
    "basis4": 0.0,
    "taxableamount4": 0.0,
    "vatcode4": "6B",
    "vatpercent4": 6,
    "vatcocontractor4": false,
    "vatamount4": 0.0,
    "amountinclvat4": 0.0,
    "basis5": 0.0,
    "taxableamount5": 0.0,
    "vatcode5": "6P",
    "vatpercent5": 6,
    "vatcocontractor5": false,
    "vatamount5": 0.0,
    "amountinclvat5": 0.0,
    "cashdiscount_expirationdate": "",
    "cashdiscount_percent": 0,
    "cashdiscount_amount": 0,
    "creditlimitation_expirationdate": "",
    "creditlimitation_percent": 0,
    "creditlimitation_amount": 0,
    "commercialdiscount_percent": 0,
    "distributeddiscount_amount": 0,
    "include_commission_in_total": true,
    "advance": 0.0,
    "balance": 0.0,
    "locked": false,
    "createdby": "DIRK",
    "lasteditedby": "DIRK",
    "approved": false,
    "approved_date": "",
    "rejected": false,
    "rejected_date": "",
    "verified": false,
    "sent": false,
    "sent_date": "",
    "signed": false,
    "billed": false,
    "detail_source": 11,
    "detail_sourcelist": "",
    "detail_ordergroups": false,
    "ts_lastupdate": "2025–02–12 14:30:47"
  }
]
}

/SalesInvoices/{id}/conclusion_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/SalesInvoices/1021/conclusion_html

with the following parameters :

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

Success gives statuscode 200 And the following result

<HTML><BODY> <DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Montserrat;font-size: 11pt;color: #000000;">Slot voor de API (niet aanpassen aub)</SPAN></DIV> </BODY></HTML>

/SalesInvoices/{id}/conclusion_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/SalesInvoices/1021/conclusion_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

Slot voor de API (niet aanpassen aub)

/SalesInvoices/{id}/conclusion_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/SalesInvoices/1021/conclusion_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 Montserrat;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs22\cf1 Slot voor de API (niet aanpassen aub)}

/SalesInvoices/{id}/introduction_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/SalesInvoices/1021/introduction_html

with the following parameters :

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

Success gives statuscode 200 And the following result

<HTML><BODY> <DIV STYLE="text-align: left;"><SPAN STYLE="font-family: Montserrat;font-size: 11pt;color: #000000;">Inleiding voor de API (niet aanpassen aub)</SPAN></DIV> </BODY></HTML>

/SalesInvoices/{id}/introduction_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/SalesInvoices/1021/introduction_plain

with the following parameters :

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

Success gives statuscode 200 And the following result

Inleiding voor de API (niet aanpassen aub)

/SalesInvoices/{id}/introduction_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/SalesInvoices/1021/introduction_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 Montserrat;}}{\colortbl ;\red0\green0\blue0;}{*\generator Spikesoft 16.02;}\ql\li0\f0\fs22\cf1 Inleiding voor de API (niet aanpassen aub)}