Payroll - Get period profile details

API Url

Use it to return details for a period profile

GET

http://localhost:16010/ProMarkREST/web/Payroll/periods/{id}/details

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
periodId	String	Period profile id.

Success 200

Field	Type	Description
periods	Object[]
close	Object
allowed`optional`	Boolean	True if its allowed to close period.
completed`optional`	DateTime	Timestamp of when the preliminary report was completed.
requested`optional`	DateTime	Timestamp of when the preliminary report was requested.
started`optional`	DateTime	Timestamp of when the preliminary report was started.
viewReport	String	True if it's possible to view preliminary report.
description	String	Description of the period profile.
end	DateTime	End time of the period.
finalClose	DateTime	Timestamp of the completed closure of the period.
finalReport	Object
allowed	Boolean	True if we have one or more validated employees.
completed`optional`	DateTime	Timestamp of when the final report was completed.
finalizedEmployees`optional`	Number	Numbers of finalized employees.
reportId`optional`	String	Report's id.
requested`optional`	DateTime	Timestamp of when the final report was requested.
started`optional`	DateTime	Timestamp of when the final report was started.
viewReport	Boolean	True if it's possible to view final report.
firstValidation	DateTime	Timestamp of the first validation on the current period profile.
id	String	Period profile id.
numberOfEmployees	Number	Total number of employee under the current period profile.
preliminaryReport	Object	First report to run on payroll process, but it is not mandatory.
allowed	Boolean	True if its allowed to run the preliminary report.
completed`optional`	DateTime	Timestamp of when the preliminary report was completed.
reportId`optional`	String	Report's id.
requested`optional`	DateTime	Timestamp of when the preliminary report was requested.
started`optional`	DateTime	Timestamp of when the preliminary report was started.
viewReport	Boolean	True if it's possible to view preliminary report.
stage	Number	Stage of payroll closure: `0`: Not started, `1`: Preliminary Report, `2`: Validated with errors, `3`: Validated, `4`: Final Report completed, `5`: Payroll transferred, `6`: Period closed with errors, `7`: Period closed.
start	DateTime	Start time of the period.
status	Number	`1`: Open, `2`: under validation and `3`: closed.
transferToHost	Object
allowed	Boolean	True if it is allowed to run Transfer to payroll.
completed`optional`	DateTime	Timestamp of when was transfer was completed.
requested`optional`	DateTime	Timestamp of when was transfer was requested.
started`optional`	DateTime	Timestamp of when was transfer was started.
transfered`optional`	Object	Number of records transferred
absence`optional`	Number	Number of transferred absence host transaction.
attendance`optional`	Number	Number of transferred attendance host transaction.
dailyAbsence`optional`	Number	Number of transactions transferred to daily absence host transaction
dailyPayroll`optional`	Number	Number of transactions transferred to daily payroll host transaction
payroll`optional`	Number	Number of transferred payroll host transaction.
viewReport	boolean	If true, there is numbers under transferred that can be displayed.
validation	Object
allowed	Boolean	True if its allowed to run period validation.
completed`optional`	DateTime	Timestamp of when the validation was completed.
requested`optional`	DateTime	Timestamp of when the validatation was requested.
started`optional`	DateTime	Timestamp of when the validation was started.
validatedEmployees`optional`	Number	Numbers of validated employees.
viewReport	String	True if it's possible to view validation report.

Success example:

{
  "periods": [
    {
      "id": "PAYROLL",
      "description": "Payroll profile for hourly paid",
      "status": 2,
      "stage": 2,
      "start": "2020-03-30T00:00:00.000",
      "end": "2020-04-06T00:00:00.000",
      "firstValidation": "2020-04-06T09:14:44.237",
      "numberOfEmployees": 22,
      "preliminaryReport": {
        "allowed": true,
        "requested": "2020-04-06T09:14:28.329",
        "started": "2020-04-06T09:14:29.891",
        "completed": "2020-04-06T09:14:29.908",
        "viewReport": true,
        "reportId": "temp-94efcb5a33d460ab66142dd97ca8f4ab"
      },
      "validation": {
        "allowed": true,
        "requested": "2020-04-06T09:14:44.114",
        "started": "2020-04-06T09:14:44.237",
        "completed": "2020-04-06T09:14:44.599",
        "viewReport": true
      },
      "finalReport": {
        "allowed": false,
        "viewReport": false
      },
      "transferToHost": {
        "allowed": false,
        "viewReport": false
      },
      "close": {
        "allowed": false,
        "viewReport": false
      }
    }
  ]
}

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.