Payroll - Get periods

API Url

Use it to return a lookup for peiods

GET

http://localhost:16010/ProMarkREST/web/Payroll/periods

Permissions: user

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.

Field	Type	Description
allowRun	Boolean	If true only return periods where it is allowed to run next step If stage is not defined, the parameter is ignored.
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. If not defined, returns all.

Field	Type	Description
periods	Object[]
description	String	Description of the period profile.
end	DateTime	End time of the period.
finalClose	DateTime	Time of the completed closure of the period.
firstValidation	DateTime	Time 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.
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.

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.