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

HTTP method	API version
GET	v1

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

API Path: /ProgressReports/
or
API Path: /ProgressReports/{id}
or
API Path: /ProgressReports/FieldInfo/

You can make this API call:
* without the key field id to get a list of ProgressReports
* with the key field id as the path parameter (the specific id of the ProgressReport you want to get)
* to request the FieldInfo for this call

Fields

The following fields are available:

Field Name	Type Name	Length	Required	Writeable	Force Write	Link
nr	tpString	250	No	No	No
vsgroupid	tpLong	0	No	No	No
vsgroupnr	tpLong	0	No	No	No
vsgroupbisnr	tpLong	0	No	No	No
date	tpDateNullString	0	No	No	No
description	tpString	50	No	No	No
executiontime	tpLong	0	No	No	No
expirationdate	tpDateNullString	0	No	No	No
amountinclvat_total	tpDouble	0	No	No	No
progressreport_datestart	tpDateNullString	0	No	No	No
progressreport_dateend	tpDateNullString	0	No	No	No
progressreport_offereddate	tpDateNullString	0	No	No	No
progressreport_approvaldate	tpDateNullString	0	No	No	No
extension	tpLong	0	No	No	No
address_id	tpLong	0	No	No	No
address_name	tpString	150	No	No	No
project_id	tpLong	0	No	No	No
project_pnr	tpLong	0	No	No	No
project_unr	tpLong	0	No	No	No
project_ref	tpString	50	No	No	No
project_name	tpString	100	No	No	No
company_id	tpLong	0	No	No	No
invoice_id	tpLong	0	No	No	No
invoice_nr	tpLong	0	No	No	No
percentage	tpBool	0	No	No	No
ts_lastupdate	tpDate	0	No	No	No

/ProgressReports/

API Path: /ProgressReports/

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

with the following parameters :

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

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: nextid, ParameterValue:

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/997”, “Records”: [
  {
    "id": 1,
    "nr": "20120001–1",
    "vsgroupid": 1,
    "vsgroupnr": 1,
    "vsgroupbisnr": 0,
    "date": "2012–03–07",
    "description": "Vorderingsstaat",
    "executiontime": 21,
    "expirationdate": "",
    "currentexecuted_total": 10742.809999999999491,
    "revision_total": 0,
    "amountexclvat_total": 10742.809999999999491,
    "amountinclvat_total": 11387.3799999999992,
    "progressreport_datestart": "2019–12–01",
    "progressreport_dateend": "2019–12–31",
    "progressreport_offereddate": "",
    "progressreport_approvaldate": "2016–02–25",
    "extension": 0,
    "address_id": 24,
    "address_name": "Gasthof Lophem",
    "project_id": 3,
    "project_pnr": 20120003,
    "project_unr": 3,
    "project_ref": "",
    "project_name": "Project: Parketvloeren",
    "company_id": 1,
    "invoice_id": 30,
    "invoice_nr": 20120004,
    "percentage": false,
    "ts_lastupdate": "2019–12–10 13:52:34"
  },
  {
    "id": 2,
    "nr": "20120002–1",
    "vsgroupid": 2,
    "vsgroupnr": 1,
    "vsgroupbisnr": 0,
    "date": "2012–04–23",
    "description": "Vorderingsstaat",
    "executiontime": 20,
    "expirationdate": "",
    "currentexecuted_total": 10384.420000000000073,
    "revision_total": 121.082350000000005,
    "amountexclvat_total": 10505.5,
    "amountinclvat_total": 11135.829999999999927,
    "progressreport_datestart": "2012–04–02",
    "progressreport_dateend": "2012–04–21",
    "progressreport_offereddate": "",
    "progressreport_approvaldate": "2018–05–30",
    "extension": 0,
    "address_id": 2687,
    "address_name": "USE IT GROUP",
    "project_id": 6,
    "project_pnr": 20120004,
    "project_unr": 6,
    "project_ref": "",
    "project_name": "Project: Ruwbouw",
    "company_id": 1,
    "invoice_id": 35,
    "invoice_nr": 20120005,
    "percentage": false,
    "ts_lastupdate": "2018–05–30 07:22:41"
  }
,
…
]
}

/ProgressReports/{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/ProgressReports/1

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 1,
    "nr": "20120001–1",
    "vsgroupid": 1,
    "vsgroupnr": 1,
    "vsgroupbisnr": 0,
    "date": "2012–03–07",
    "description": "Vorderingsstaat",
    "executiontime": 21,
    "expirationdate": "",
    "currentexecuted_total": 10742.809999999999491,
    "revision_total": 0,
    "amountexclvat_total": 10742.809999999999491,
    "amountinclvat_total": 11387.3799999999992,
    "progressreport_datestart": "2019–12–01",
    "progressreport_dateend": "2019–12–31",
    "progressreport_offereddate": "",
    "progressreport_approvaldate": "2016–02–25",
    "extension": 0,
    "address_id": 24,
    "address_name": "Gasthof Lophem",
    "project_id": 3,
    "project_pnr": 20120003,
    "project_unr": 3,
    "project_ref": "",
    "project_name": "Project: Parketvloeren",
    "company_id": 1,
    "invoice_id": 30,
    "invoice_nr": 20120004,
    "percentage": false,
    "ts_lastupdate": "2019–12–10 13:52:34"
  }
]
}

/ProgressReports/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/ProgressReports/FieldInfo

with the following parameters :

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

Success gives statuscode 200 And the following result

[
  {
    "name": "nr",
    "type_id": 2,
    "type_name": "tpString",
    "length": 250,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  },
  {
    "name": "vsgroupid",
    "type_id": 1,
    "type_name": "tpLong",
    "length": 0,
    "required": false,
    "writeable": false,
    "forcewrite": false,
    "link": ""
  }
,
…
]