Payroll - Run payroll report
API Url
Use it to run a report in Payroll webpart
POST
http://localhost:16010/ProMarkREST/web/Payroll/reports
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| reports | Object[] | |
| periodId | String | The Period Profile ID for which the report should be executed |
| reportType | Number | 1: Preliminary report 3: Final report |
Request example:
{"request": {"data": {"reports": [{"periodId": "PER1","reportType": 1},{"periodId": "PER2","reportType": 1}]}}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |