| VismaBouwsoftAPICalls.v1_GET_SalesDocuments | Method |
This API call is used to get fields of a(n) SalesDocument(s)
| HTTP method | API version |
|---|---|
| GET | v1 |
Don’t forget to put the Authorization field in the header
API Path: /SalesDocuments/
or
API Path: /SalesDocuments/{id}
or
API Path: /SalesDocuments/FieldInfo/
You can make this API call:
* without the key field id to get a list of SalesDocuments
* with the key field id as the path parameter (the specific id of the SalesDocument you want to get)
* to request the FieldInfo for this call
Fields
The following fields are available:
| Field Name | Type Id | Type Name | Length | Required | Writeable | Force Write | Link |
|---|---|---|---|---|---|---|---|
| company_id | 1 | tpLong | 0 | No | Yes | No | |
| company_name | 2 | tpString | 250 | No | No | No | |
| type | 2 | tpString | 50 | Yes | No | No | |
| type_localized | 2 | tpString | 50 | No | No | No | |
| type_id | 1 | tpLong | 0 | No | No | No | |
| nr | 1 | tpLong | 0 | No | Yes | No | |
| nr_add | 2 | tpString | 5 | No | Yes | No | |
| date | 3 | tpDate | 0 | No | Yes | No | |
| expirationdate | 3 | tpDate | 0 | No | Yes | No | |
| title | 2 | tpString | 50 | No | Yes | No | |
| concerning | 2 | tpString | 100 | No | Yes | No | |
| ordernr | 2 | tpString | 100 | No | Yes | No | |
| pricedecimals | 1 | tpLong | 0 | No | Yes | No | |
| ledger | 1 | tpLong | 0 | No | Yes | No | |
| workingdocumentdata_id | 1 | tpLong | 0 | No | No | No | WorkingDocumentData |
| address_id | 1 | tpLong | 0 | No | Yes | No | Addresses |
| address_salutation | 2 | tpString | 50 | No | No | No | |
| address_name | 2 | tpString | 150 | No | No | No | |
| address_address | 2 | tpString | 63 | No | No | No | |
| address_addressline2 | 2 | tpString | 63 | No | No | No | |
| address_latitude | 4 | tpDouble | 0 | No | No | No | |
| address_longitude | 4 | tpDouble | 0 | No | No | No | |
| address_countrycode | 2 | tpString | 2 | No | No | No | |
| address_zipcode | 2 | tpString | 15 | No | No | No | |
| address_city | 2 | tpString | 40 | No | No | No | |
| address_state | 2 | tpString | 40 | No | No | No | |
| address_readonly | 5 | tpBool | 0 | No | No | No | |
| shippingaddress_address | 2 | tpString | 63 | No | No | No | |
| shippingaddress_addressline2 | 2 | tpString | 63 | No | No | No | |
| shippingaddress_latitude | 4 | tpDouble | 0 | No | No | No | |
| shippingaddress_longitude | 4 | tpDouble | 0 | No | No | No | |
| shippingaddress_countrycode | 2 | tpString | 2 | No | No | No | |
| shippingaddress_zipcode | 2 | tpString | 15 | No | No | No | |
| shippingaddress_city | 2 | tpString | 40 | No | No | No | |
| shippingaddress_state | 2 | tpString | 40 | No | No | No | |
| contact_id | 1 | tpLong | 0 | No | Yes | Yes | AddressContacts |
| contact_salutation | 2 | tpString | 50 | No | No | No | |
| contact_name | 2 | tpString | 100 | No | No | No | |
| vatnr | 2 | tpString | 50 | No | No | No | |
| gln | 2 | tpString | 13 | No | No | No | |
| be_rpr | 2 | tpString | 50 | No | No | No | |
| telephone1 | 9 | tpTelefoon | 25 | No | No | No | |
| telephone2 | 9 | tpTelefoon | 25 | No | No | No | |
| fax | 15 | tpFax | 25 | No | No | No | |
| gsm | 9 | tpTelefoon | 25 | No | No | No | |
| 10 | tpEmail | 100 | No | No | No | ||
| project_id | 1 | tpLong | 0 | No | Yes | No | Projects |
| project_pnr | 1 | tpLong | 0 | No | No | No | |
| project_unr | 1 | tpLong | 0 | No | No | No | |
| project_name | 2 | tpString | 100 | No | No | No | |
| yourreference | 2 | tpString | 50 | No | No | No | |
| be_werkplaatsnr30bis | 2 | tpString | 50 | No | No | No | |
| basis | 8 | tpCurrency | 0 | No | No | No | |
| vatcode | 2 | tpString | 0 | No | Yes | No | |
| vatpercent | 4 | tpDouble | 0 | No | No | No | |
| vatamount | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat | 8 | tpCurrency | 0 | No | No | No | |
| basis1 | 8 | tpCurrency | 0 | No | No | No | |
| taxableamount1 | 8 | tpCurrency | 0 | No | No | No | |
| vatcode1_id | 1 | tpLong | 0 | No | No | No | |
| vatcode1 | 2 | tpString | 5 | No | No | No | |
| vatpercent1 | 4 | tpDouble | 0 | No | No | No | |
| vatcocontractor1 | 5 | tpBool | 0 | No | No | No | |
| vatamount1 | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat1 | 8 | tpCurrency | 0 | No | No | No | |
| basis2 | 8 | tpCurrency | 0 | No | No | No | |
| taxableamount2 | 8 | tpCurrency | 0 | No | No | No | |
| vatcode2_id | 1 | tpLong | 0 | No | No | No | |
| vatcode2 | 2 | tpString | 5 | No | No | No | |
| vatpercent2 | 4 | tpDouble | 0 | No | No | No | |
| vatcocontractor2 | 5 | tpBool | 0 | No | No | No | |
| vatamount2 | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat2 | 8 | tpCurrency | 0 | No | No | No | |
| basis3 | 8 | tpCurrency | 0 | No | No | No | |
| taxableamount3 | 8 | tpCurrency | 0 | No | No | No | |
| vatcode3_id | 1 | tpLong | 0 | No | No | No | |
| vatcode3 | 2 | tpString | 5 | No | No | No | |
| vatpercent3 | 4 | tpDouble | 0 | No | No | No | |
| vatcocontractor3 | 5 | tpBool | 0 | No | No | No | |
| vatamount3 | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat3 | 8 | tpCurrency | 0 | No | No | No | |
| basis4 | 8 | tpCurrency | 0 | No | No | No | |
| taxableamount4 | 8 | tpCurrency | 0 | No | No | No | |
| vatcode4_id | 1 | tpLong | 0 | No | No | No | |
| vatcode4 | 2 | tpString | 5 | No | No | No | |
| vatpercent4 | 4 | tpDouble | 0 | No | No | No | |
| vatcocontractor4 | 5 | tpBool | 0 | No | No | No | |
| vatamount4 | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat4 | 8 | tpCurrency | 0 | No | No | No | |
| basis5 | 8 | tpCurrency | 0 | No | No | No | |
| taxableamount5 | 8 | tpCurrency | 0 | No | No | No | |
| vatcode5_id | 1 | tpLong | 0 | No | No | No | |
| vatcode5 | 2 | tpString | 5 | No | No | No | |
| vatpercent5 | 4 | tpDouble | 0 | No | No | No | |
| vatcocontractor5 | 5 | tpBool | 0 | No | No | No | |
| vatamount5 | 8 | tpCurrency | 0 | No | No | No | |
| amountinclvat5 | 8 | tpCurrency | 0 | No | No | No | |
| cashdiscount_expirationdate | 6 | tpDateNullString | 0 | No | No | No | |
| cashdiscount_percent | 4 | tpDouble | 0 | No | Yes | No | |
| cashdiscount_amount | 4 | tpDouble | 0 | No | No | No | |
| creditlimitation_expirationdate | 6 | tpDateNullString | 0 | No | No | No | |
| creditlimitation_percent | 4 | tpDouble | 0 | No | Yes | No | |
| creditlimitation_amount | 4 | tpDouble | 0 | No | No | No | |
| commercialdiscount_percent | 4 | tpDouble | 0 | No | Yes | No | |
| distributeddiscount_amount | 4 | tpDouble | 0 | No | Yes | No | |
| include_commission_in_total | 5 | tpBool | 0 | No | Yes | No | |
| advance | 8 | tpCurrency | 0 | No | Yes | No | |
| balance | 8 | tpCurrency | 0 | No | No | No | |
| blocked | 5 | tpBool | 0 | No | Yes | No | |
| locked | 5 | tpBool | 0 | No | No | No | |
| createdby | 2 | tpString | 50 | No | No | No | |
| lasteditedby | 2 | tpString | 50 | No | No | No | |
| approved | 5 | tpBool | 0 | No | Yes | No | |
| approved_date | 6 | tpDateNullString | 0 | No | Yes | No | |
| rejected | 5 | tpBool | 0 | No | Yes | No | |
| rejected_date | 6 | tpDateNullString | 0 | No | Yes | No | |
| verified | 5 | tpBool | 0 | No | Yes | No | |
| sent | 5 | tpBool | 0 | No | Yes | No | |
| sent_date | 6 | tpDateNullString | 0 | No | Yes | No | |
| signed | 5 | tpBool | 0 | No | No | No | |
| billed | 5 | tpBool | 0 | No | Yes | No | |
| detail_source | 1 | tpLong | 0 | No | Yes | No | |
| detail_sourcelist | 2 | tpString | 50 | No | Yes | No | |
| detail_ordergroups | 5 | tpBool | 0 | No | Yes | No | |
| einvoice_date | 6 | tpDateNullString | 0 | No | No | No | |
| has_split_vat | 5 | tpBool | 0 | No | No | No | |
| ts_lastupdate | 3 | tpDate | 0 | No | No | No |
/SalesDocuments/
API Path: /SalesDocuments/
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/SalesDocuments
with the following parameters :
Header Parameters :
ParameterName: AccessToken, ParameterValue: trbfWxfkIOzSfGPDktzRqOVbftGVIOmOjDjtzmmDttjGfDlVGl
ParameterName: Clientnr, ParameterValue: 115
Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–4/7301”,
“Records”:
[
{
"id": 19,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "BESCHERMINGSMIDDELEN",
"type_localized": "MEANS OF PROTECTION",
"type_id": 22,
"nr": 1,
"nr_add": "",
"date": "2012–03–06",
"expirationdate": "2012–03–06",
"title": "",
"concerning": "",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 5,
"address_id": 0,
"address_salutation": "",
"address_name": "Deblauwe Gino",
"address_address": "Gruthof",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"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": 0,
"contact_salutation": "",
"contact_name": "",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 0.0,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 0.0,
"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": 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": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": false,
"approved_date": "",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 0,
"detail_sourcelist": "",
"detail_ordergroups": false,
"ts_lastupdate": "2019–10–23 09:50:50"
},
{
"id": 22,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "OFFERTE",
"type_localized": "OFFER",
"type_id": 1,
"nr": 20120002,
"nr_add": "",
"date": "2012–03–07",
"expirationdate": "2012–06–05",
"title": "",
"concerning": "Plaatsen van parket in hoeve hotel",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 8,
"address_id": 24,
"address_salutation": "BVBA",
"address_name": "Gasthof Lophem",
"address_address": "Zeedijkweg 23a",
"address_addressline2": "",
"address_latitude": 51.142470000000003,
"address_longitude": 3.18053,
"address_countrycode": "BE",
"address_zipcode": "8210",
"address_city": "Loppem",
"address_state": "West-vlaanderen",
"address_readonly": false,
"shippingaddress_address": "Zeedijkweg 23 A",
"shippingaddress_addressline2": "",
"shippingaddress_latitude": 51.142470000000003,
"shippingaddress_longitude": 3.18053,
"shippingaddress_countrycode": "BE",
"shippingaddress_zipcode": "8210",
"shippingaddress_city": "Loppem",
"shippingaddress_state": "West-vlaanderen",
"contact_id": 4,
"contact_salutation": "De Heer",
"contact_name": "Lutters carl",
"vatnr": "BTW BE 0885.429.559",
"gln": "",
"be_rpr": "Brugge",
"telephone1": "+32 50 82 21 67 ",
"telephone2": "",
"fax": "+32 50 40 04 80 ",
"gsm": "",
"email": "carl.lutters@gmail.com",
"project_id": 3,
"project_pnr": 20120003,
"project_unr": 3,
"project_name": "Project: Parketvloeren",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 11108.1200000000008,
"vatcode": "6",
"vatpercent": 6,
"vatamount": 666.490000000000009,
"amountinclvat": 11774.610000000000582,
"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": 11108.1200000000008,
"taxableamount3": 11108.1200000000008,
"vatcode3": "6",
"vatpercent3": 6,
"vatcocontractor3": false,
"vatamount3": 666.490000000000009,
"amountinclvat3": 11774.610000000000582,
"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": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": true,
"approved_date": "2012–03–07",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 11,
"detail_sourcelist": "",
"detail_ordergroups": true,
"ts_lastupdate": "2022–04–28 12:40:30"
}
,
…
]
}
/SalesDocuments/{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/SalesDocuments/19
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: AfbfWxfDbVzSfrbrrfzRqGDUfkPkfGbAffbkzDfAjPmGklkIIr
Success gives statuscode 200 And the following result
{
“Content-Range”:“0–0/1”,
“Records”:
[
{
"id": 19,
"company_id": 1,
"company_name": "Bouwsoft",
"type": "BESCHERMINGSMIDDELEN",
"type_localized": "MEANS OF PROTECTION",
"type_id": 22,
"nr": 1,
"nr_add": "",
"date": "2012–03–06",
"expirationdate": "2012–03–06",
"title": "",
"concerning": "",
"ordernr": "",
"pricedecimals": 2,
"ledger": 70000,
"workingdocumentdata_id": 5,
"address_id": 0,
"address_salutation": "",
"address_name": "Deblauwe Gino",
"address_address": "Gruthof",
"address_addressline2": "",
"address_latitude": 0,
"address_longitude": 0,
"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": 0,
"contact_salutation": "",
"contact_name": "",
"vatnr": "",
"gln": "",
"be_rpr": "",
"telephone1": "",
"telephone2": "",
"fax": "",
"gsm": "",
"email": "",
"project_id": 0,
"project_pnr": 0,
"project_unr": 0,
"project_name": "",
"yourreference": "",
"be_werkplaatsnr30bis": "",
"basis": 0.0,
"vatcode": "0",
"vatpercent": 0,
"vatamount": 0.0,
"amountinclvat": 0.0,
"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": 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": 0,
"distributeddiscount_amount": 0,
"include_commission_in_total": true,
"advance": 0.0,
"balance": 0.0,
"blocked": false,
"locked": false,
"createdby": "",
"lasteditedby": "",
"approved": false,
"approved_date": "",
"rejected": false,
"rejected_date": "",
"verified": false,
"sent": false,
"sent_date": "",
"signed": false,
"billed": false,
"detail_source": 0,
"detail_sourcelist": "",
"detail_ordergroups": false,
"ts_lastupdate": "2019–10–23 09:50:50"
}
]
}
/SalesDocuments/FieldInfo
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/SalesDocuments/FieldInfo
with the following parameters :
Header Parameters :
ParameterName: AccessToken, ParameterValue: ffjfWxfODjzSfPGtOtzRqUUUfkGUIOrmjIAtzOttOjVGrUAkrO
ParameterName: Clientnr, ParameterValue: 115
Success gives statuscode 200 And the following result
[
{
"name": "company_id",
"type_id": 1,
"type_name": "tpLong",
"length": 0,
"required": false,
"writeable": true,
"forcewrite": false,
"link": ""
},
{
"name": "company_name",
"type_id": 2,
"type_name": "tpString",
"length": 250,
"required": false,
"writeable": false,
"forcewrite": false,
"link": ""
}
,
…
]