GET api/Payroll?payrollNo={payrollNo}

Get the pay periods for the given payroll upto the current period

Request Information

URI Parameters

Name	Description	Type	Additional information
payrollNo	Payroll No	string	Required

Body Parameters

None.

Response Information

Resource Description

PayrollPayPeriods

Name	Description	Type	Additional information
PayPeriods		Collection of PayPeriods	None.

Response Formats

application/json, text/json

Sample:

{
    "PayPeriods": 
    [
        {
            "Open": "Yes",
            "PayPeriod": "202109",
            "PayDate": "2021-12-31T00:00:00",
            "StartDate": "2021-12-01T00:00:00",
            "EndDate": "2021-12-31T00:00:00",
            "CutOffDate": "2021-12-31T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202108",
            "PayDate": "2021-11-30T00:00:00",
            "StartDate": "2021-11-01T00:00:00",
            "EndDate": "2021-11-30T00:00:00",
            "CutOffDate": "2021-11-30T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202107",
            "PayDate": "2021-10-31T00:00:00",
            "StartDate": "2021-10-01T00:00:00",
            "EndDate": "2021-10-31T00:00:00",
            "CutOffDate": "2021-10-31T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202106",
            "PayDate": "2021-09-30T00:00:00",
            "StartDate": "2021-09-01T00:00:00",
            "EndDate": "2021-09-30T00:00:00",
            "CutOffDate": "2021-09-30T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202105",
            "PayDate": "2021-08-31T00:00:00",
            "StartDate": "2021-08-01T00:00:00",
            "EndDate": "2021-08-31T00:00:00",
            "CutOffDate": "2021-08-31T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202104",
            "PayDate": "2021-07-31T00:00:00",
            "StartDate": "2021-07-01T00:00:00",
            "EndDate": "2021-07-31T00:00:00",
            "CutOffDate": "2021-07-31T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202103",
            "PayDate": "2021-06-30T00:00:00",
            "StartDate": "2021-06-01T00:00:00",
            "EndDate": "2021-06-30T00:00:00",
            "CutOffDate": "2021-06-30T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202102",
            "PayDate": "2021-05-31T00:00:00",
            "StartDate": "2021-05-01T00:00:00",
            "EndDate": "2021-05-31T00:00:00",
            "CutOffDate": "2021-05-31T00:00:00",
            "isFirstPeriod": false,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        },
        {
            "Open": "No",
            "PayPeriod": "202101",
            "PayDate": "2021-04-30T00:00:00",
            "StartDate": "2021-04-01T00:00:00",
            "EndDate": "2021-04-30T00:00:00",
            "CutOffDate": "2021-04-30T00:00:00",
            "isFirstPeriod": true,
            "isLastPeriod": false,
            "totalPeriodsInYear": 12,
            "payFrequency": 1
        }
    ]
}