POST api/{programid}/Employee/GetLastPayStub

Returns the most recent PayStub for a Provider

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

Necessary Information for Last Paycheck to Return

EmployeeLastPayStubRequestParams

Name	Description	Type	Additional information
ProviderId		string	None.
ParticipantId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProviderId": "sample string 1",
  "ParticipantId": "sample string 2"
}

application/xml, text/xml

Sample:

<EmployeeLastPayStubRequestParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee">
  <ParticipantId>sample string 2</ParticipantId>
  <ProviderId>sample string 1</ProviderId>
</EmployeeLastPayStubRequestParams>

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 'EmployeeLastPayStubRequestParams'.

Response Information

Resource Description

PayStub

Name	Type	Additional information
CheckNo	string	None.
ConsumerNo	string	None.
ConsumerName	string	None.
ProviderId	string	None.
ProviderName	string	None.
PayDate	date	None.
NetPay	decimal number	None.
CheckStartDate	date	None.
CheckEndDate	date	None.
TotalEarnings	decimal number	None.
WorkedHours	decimal number	None.
PaidHours	decimal number	None.
TimeEntries		None.

Response Formats

application/json, text/json

Sample:

{
  "CheckNo": "sample string 1",
  "ConsumerNo": "sample string 2",
  "ConsumerName": "sample string 3",
  "ProviderId": "sample string 4",
  "ProviderName": "sample string 5",
  "PayDate": "2025-01-18T00:14:50.6590054-05:00",
  "NetPay": 7.0,
  "CheckStartDate": "2025-01-18T00:14:50.6590054-05:00",
  "CheckEndDate": "2025-01-18T00:14:50.6590054-05:00",
  "TotalEarnings": 10.0,
  "WorkedHours": 11.1,
  "PaidHours": 12.1,
  "TimeEntries": [
    {
      "TimesheetNo": "sample string 1",
      "LineId": 2,
      "EntryNo": 3,
      "HoursPaid": 4.0,
      "InTime": "2025-01-18T00:14:50.6590054-05:00",
      "OutTime": "2025-01-18T00:14:50.6590054-05:00",
      "DateWorked": "2025-01-18T00:14:50.6590054-05: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-01-18T00:14:50.6590054-05:00",
      "OutTime": "2025-01-18T00:14:50.6590054-05:00",
      "DateWorked": "2025-01-18T00:14:50.6590054-05: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:

<EmployeePayStubList.PayStub xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Employee">
  <CheckEndDate>2025-01-18T00:14:50.6590054-05:00</CheckEndDate>
  <CheckNo>sample string 1</CheckNo>
  <CheckStartDate>2025-01-18T00:14:50.6590054-05:00</CheckStartDate>
  <ConsumerName>sample string 3</ConsumerName>
  <ConsumerNo>sample string 2</ConsumerNo>
  <NetPay>7</NetPay>
  <PaidHours>12.1</PaidHours>
  <PayDate>2025-01-18T00:14:50.6590054-05: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-01-18T00:14:50.6590054-05:00</DateWorked>
      <EntryNo>3</EntryNo>
      <HoursPaid>4</HoursPaid>
      <InTime>2025-01-18T00:14:50.6590054-05:00</InTime>
      <LineId>2</LineId>
      <OutTime>2025-01-18T00:14:50.6590054-05: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-01-18T00:14:50.6590054-05:00</DateWorked>
      <EntryNo>3</EntryNo>
      <HoursPaid>4</HoursPaid>
      <InTime>2025-01-18T00:14:50.6590054-05:00</InTime>
      <LineId>2</LineId>
      <OutTime>2025-01-18T00:14:50.6590054-05:00</OutTime>
      <ServiceDescription>sample string 8</ServiceDescription>
      <TimesheetNo>sample string 1</TimesheetNo>
    </EmployeePayStubList.TimeEntry>
  </TimeEntries>
  <TotalEarnings>10</TotalEarnings>
  <WorkedHours>11.1</WorkedHours>
</EmployeePayStubList.PayStub>