POST api/{programid}/Employee/PayStubList

Get pay stubs for a provider.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

EmployeePayStubListRequestParams

Name	Type	Additional information
ProgramCode	string	None.
ProviderId	string	None.
ParticipantId	string	None.
Year	integer	None.
DateTo	date	None.
DateFrom	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ProgramCode": "sample string 1",
  "ProviderId": "sample string 2",
  "ParticipantId": "sample string 3",
  "Year": 1,
  "DateTo": "2025-08-15T22:59:56.5547252-04:00",
  "DateFrom": "2025-08-15T22:59:56.5547252-04:00"
}

application/xml, text/xml

Sample:

<EmployeePayStubListRequestParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee">
  <DateFrom>2025-08-15T22:59:56.5547252-04:00</DateFrom>
  <DateTo>2025-08-15T22:59:56.5547252-04:00</DateTo>
  <ParticipantId>sample string 3</ParticipantId>
  <ProgramCode>sample string 1</ProgramCode>
  <ProviderId>sample string 2</ProviderId>
  <Year>1</Year>
</EmployeePayStubListRequestParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EmployeePayStubListRequestParams'.

Response Information

Resource Description

EmployeePayStubListResponse

Name	Type	Additional information
ProviderId	string	None.
AvgMonthlyIncome	decimal number	None.
PayStubs	Collection of PayStub	None.

Response Formats

application/json, text/json

Sample:

{
  "ProviderId": "sample string 1",
  "AvgMonthlyIncome": 2.0,
  "PayStubs": [
    {
      "CheckNo": "sample string 1",
      "ConsumerNo": "sample string 2",
      "ConsumerName": "sample string 3",
      "ProviderId": "sample string 4",
      "ProviderName": "sample string 5",
      "PayDate": "2025-08-15T22:59:56.5703829-04:00",
      "NetPay": 7.0,
      "CheckStartDate": "2025-08-15T22:59:56.5703829-04:00",
      "CheckEndDate": "2025-08-15T22:59:56.5703829-04:00",
      "TotalEarnings": 10.0,
      "WorkedHours": 11.1,
      "PaidHours": 12.1,
      "TimeEntries": [
        {
          "TimesheetNo": "sample string 1",
          "LineId": 2,
          "EntryNo": 3,
          "HoursPaid": 4.0,
          "InTime": "2025-08-15T22:59:56.5703829-04:00",
          "OutTime": "2025-08-15T22:59:56.5703829-04:00",
          "DateWorked": "2025-08-15T22:59:56.5703829-04:00",
          "ServiceDescription": "sample string 8",
          "Activities": [
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            },
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            }
          ]
        },
        {
          "TimesheetNo": "sample string 1",
          "LineId": 2,
          "EntryNo": 3,
          "HoursPaid": 4.0,
          "InTime": "2025-08-15T22:59:56.5703829-04:00",
          "OutTime": "2025-08-15T22:59:56.5703829-04:00",
          "DateWorked": "2025-08-15T22:59:56.5703829-04:00",
          "ServiceDescription": "sample string 8",
          "Activities": [
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            },
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            }
          ]
        }
      ]
    },
    {
      "CheckNo": "sample string 1",
      "ConsumerNo": "sample string 2",
      "ConsumerName": "sample string 3",
      "ProviderId": "sample string 4",
      "ProviderName": "sample string 5",
      "PayDate": "2025-08-15T22:59:56.5703829-04:00",
      "NetPay": 7.0,
      "CheckStartDate": "2025-08-15T22:59:56.5703829-04:00",
      "CheckEndDate": "2025-08-15T22:59:56.5703829-04:00",
      "TotalEarnings": 10.0,
      "WorkedHours": 11.1,
      "PaidHours": 12.1,
      "TimeEntries": [
        {
          "TimesheetNo": "sample string 1",
          "LineId": 2,
          "EntryNo": 3,
          "HoursPaid": 4.0,
          "InTime": "2025-08-15T22:59:56.5703829-04:00",
          "OutTime": "2025-08-15T22:59:56.5703829-04:00",
          "DateWorked": "2025-08-15T22:59:56.5703829-04:00",
          "ServiceDescription": "sample string 8",
          "Activities": [
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            },
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            }
          ]
        },
        {
          "TimesheetNo": "sample string 1",
          "LineId": 2,
          "EntryNo": 3,
          "HoursPaid": 4.0,
          "InTime": "2025-08-15T22:59:56.5703829-04:00",
          "OutTime": "2025-08-15T22:59:56.5703829-04:00",
          "DateWorked": "2025-08-15T22:59:56.5703829-04:00",
          "ServiceDescription": "sample string 8",
          "Activities": [
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            },
            {
              "EntryNo": 1,
              "TimesheetNo": "sample string 2",
              "LineId": 3,
              "Number": "sample string 4",
              "Description": "sample string 5"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<EmployeePayStubListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee">
  <AvgMonthlyIncome>2</AvgMonthlyIncome>
  <PayStubs>
    <EmployeePayStubList.PayStub>
      <CheckEndDate>2025-08-15T22:59:56.5703829-04:00</CheckEndDate>
      <CheckNo>sample string 1</CheckNo>
      <CheckStartDate>2025-08-15T22:59:56.5703829-04:00</CheckStartDate>
      <ConsumerName>sample string 3</ConsumerName>
      <ConsumerNo>sample string 2</ConsumerNo>
      <NetPay>7</NetPay>
      <PaidHours>12.1</PaidHours>
      <PayDate>2025-08-15T22:59:56.5703829-04:00</PayDate>
      <ProviderId>sample string 4</ProviderId>
      <ProviderName>sample string 5</ProviderName>
      <TimeEntries>
        <EmployeePayStubList.TimeEntry>
          <Activities>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
          </Activities>
          <DateWorked>2025-08-15T22:59:56.5703829-04:00</DateWorked>
          <EntryNo>3</EntryNo>
          <HoursPaid>4</HoursPaid>
          <InTime>2025-08-15T22:59:56.5703829-04:00</InTime>
          <LineId>2</LineId>
          <OutTime>2025-08-15T22:59:56.5703829-04:00</OutTime>
          <ServiceDescription>sample string 8</ServiceDescription>
          <TimesheetNo>sample string 1</TimesheetNo>
        </EmployeePayStubList.TimeEntry>
        <EmployeePayStubList.TimeEntry>
          <Activities>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
          </Activities>
          <DateWorked>2025-08-15T22:59:56.5703829-04:00</DateWorked>
          <EntryNo>3</EntryNo>
          <HoursPaid>4</HoursPaid>
          <InTime>2025-08-15T22:59:56.5703829-04:00</InTime>
          <LineId>2</LineId>
          <OutTime>2025-08-15T22:59:56.5703829-04:00</OutTime>
          <ServiceDescription>sample string 8</ServiceDescription>
          <TimesheetNo>sample string 1</TimesheetNo>
        </EmployeePayStubList.TimeEntry>
      </TimeEntries>
      <TotalEarnings>10</TotalEarnings>
      <WorkedHours>11.1</WorkedHours>
    </EmployeePayStubList.PayStub>
    <EmployeePayStubList.PayStub>
      <CheckEndDate>2025-08-15T22:59:56.5703829-04:00</CheckEndDate>
      <CheckNo>sample string 1</CheckNo>
      <CheckStartDate>2025-08-15T22:59:56.5703829-04:00</CheckStartDate>
      <ConsumerName>sample string 3</ConsumerName>
      <ConsumerNo>sample string 2</ConsumerNo>
      <NetPay>7</NetPay>
      <PaidHours>12.1</PaidHours>
      <PayDate>2025-08-15T22:59:56.5703829-04:00</PayDate>
      <ProviderId>sample string 4</ProviderId>
      <ProviderName>sample string 5</ProviderName>
      <TimeEntries>
        <EmployeePayStubList.TimeEntry>
          <Activities>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
          </Activities>
          <DateWorked>2025-08-15T22:59:56.5703829-04:00</DateWorked>
          <EntryNo>3</EntryNo>
          <HoursPaid>4</HoursPaid>
          <InTime>2025-08-15T22:59:56.5703829-04:00</InTime>
          <LineId>2</LineId>
          <OutTime>2025-08-15T22:59:56.5703829-04:00</OutTime>
          <ServiceDescription>sample string 8</ServiceDescription>
          <TimesheetNo>sample string 1</TimesheetNo>
        </EmployeePayStubList.TimeEntry>
        <EmployeePayStubList.TimeEntry>
          <Activities>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
            <EmployeePayStubList.Activity>
              <Description>sample string 5</Description>
              <EntryNo>1</EntryNo>
              <LineId>3</LineId>
              <Number>sample string 4</Number>
              <TimesheetNo>sample string 2</TimesheetNo>
            </EmployeePayStubList.Activity>
          </Activities>
          <DateWorked>2025-08-15T22:59:56.5703829-04:00</DateWorked>
          <EntryNo>3</EntryNo>
          <HoursPaid>4</HoursPaid>
          <InTime>2025-08-15T22:59:56.5703829-04:00</InTime>
          <LineId>2</LineId>
          <OutTime>2025-08-15T22:59:56.5703829-04:00</OutTime>
          <ServiceDescription>sample string 8</ServiceDescription>
          <TimesheetNo>sample string 1</TimesheetNo>
        </EmployeePayStubList.TimeEntry>
      </TimeEntries>
      <TotalEarnings>10</TotalEarnings>
      <WorkedHours>11.1</WorkedHours>
    </EmployeePayStubList.PayStub>
  </PayStubs>
  <ProviderId>sample string 1</ProviderId>
</EmployeePayStubListResponse>