Quality Score (Beta)
Quality Score provides a score against the quality of an engagement’s bookkeeping.
v1/reports/quality-score/engagements/{engagementId}/year=
Required Parameters
| Parameter | Description | Location |
|---|---|---|
enagementId Integer |
The unique identifier for the Engagement | Path |
authorization string |
Valid access token (JSON Web Token) | Header |
Ocp-Apim-Subscription-Key string |
API Key fetched from DataShare Admin``` string |
Header |
ranges string |
Either ranges or year is required. Starting and Ending Period Identifier separated by a colon (can be multiple ranges when Comma-separated). Can only have ranges or year and must have at least one stated. | query string parameter |
year string |
Either ranges or year is required. Options to input are: Current – Current financial year to date, Previous1 – Last full financial year, Previous2 – Penultimate full financial year, Previous3 – etc. | query string parameter |
Optional Parameters
| Parameter | Description | Location |
|---|---|---|
acceptUnassigned boolean |
See acceptUnassigned | query string parameter |
curl -X GET \
https://api.{environment}.validis.com/v1/reports/quality-score/
engagements/{engagementId}?year=current \
-H 'Authorization: bearer {Your_Auth_Token} \
-H 'Ocp-Apim-Subscription-Key: {Your_API_Key}' \
