GET api/{programid}/Consumer/{consumerNo}/PayCycles/{dateFrom}/{dateOfService}

Returns the paycycles of the consumer based on PPL Setup configuration (District or Consumer based)

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required
consumerNo	Consumer no.	string	Required
dateFrom	(Optional)Filters the pay periods where "End Date" is greater than datefrom. Will default to only one year back if not provided.	date	None.
dateOfService	(Optional)Filters the pay cycle period on which the dateOfService falls	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PayCyclePeriod

Name	Type	Additional information
PayCycleCode	string	None.
PayCycleTerm	string	None.
Period	integer	None.
StartDate	date	None.
EndDate	date	None.
PayDate	date	None.
InsurableHours	decimal number	None.
CutOffDate	date	None.
ClientPaymentDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PayCycleCode": "sample string 1",
    "PayCycleTerm": "sample string 2",
    "Period": 3,
    "StartDate": "2025-10-26T07:19:54.6102166+00:00",
    "EndDate": "2025-10-26T07:19:54.6102166+00:00",
    "PayDate": "2025-10-26T07:19:54.6102166+00:00",
    "InsurableHours": 7.0,
    "CutOffDate": "2025-10-26T07:19:54.6102166+00:00",
    "ClientPaymentDate": "2025-10-26T07:19:54.6102166+00:00"
  },
  {
    "PayCycleCode": "sample string 1",
    "PayCycleTerm": "sample string 2",
    "Period": 3,
    "StartDate": "2025-10-26T07:19:54.6102166+00:00",
    "EndDate": "2025-10-26T07:19:54.6102166+00:00",
    "PayDate": "2025-10-26T07:19:54.6102166+00:00",
    "InsurableHours": 7.0,
    "CutOffDate": "2025-10-26T07:19:54.6102166+00:00",
    "ClientPaymentDate": "2025-10-26T07:19:54.6102166+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPayCyclePeriod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.Payroll">
  <PayCyclePeriod>
    <ClientPaymentDate>2025-10-26T07:19:54.6102166+00:00</ClientPaymentDate>
    <CutOffDate>2025-10-26T07:19:54.6102166+00:00</CutOffDate>
    <EndDate>2025-10-26T07:19:54.6102166+00:00</EndDate>
    <InsurableHours>7</InsurableHours>
    <PayCycleCode>sample string 1</PayCycleCode>
    <PayCycleTerm>sample string 2</PayCycleTerm>
    <PayDate>2025-10-26T07:19:54.6102166+00:00</PayDate>
    <Period>3</Period>
    <StartDate>2025-10-26T07:19:54.6102166+00:00</StartDate>
  </PayCyclePeriod>
  <PayCyclePeriod>
    <ClientPaymentDate>2025-10-26T07:19:54.6102166+00:00</ClientPaymentDate>
    <CutOffDate>2025-10-26T07:19:54.6102166+00:00</CutOffDate>
    <EndDate>2025-10-26T07:19:54.6102166+00:00</EndDate>
    <InsurableHours>7</InsurableHours>
    <PayCycleCode>sample string 1</PayCycleCode>
    <PayCycleTerm>sample string 2</PayCycleTerm>
    <PayDate>2025-10-26T07:19:54.6102166+00:00</PayDate>
    <Period>3</Period>
    <StartDate>2025-10-26T07:19:54.6102166+00:00</StartDate>
  </PayCyclePeriod>
</ArrayOfPayCyclePeriod>