POST api/{programid}/Timesheets/GetRecentEarningsSnapshotFilters

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

string

Required

Body Parameters

GetRecentEarningsFiltersDTO
NameDescriptionTypeAdditional information
ProviderIDs

Collection of string

None.
Flags

Collection of Flag

None.
WorkedDateRange

WorkedDateRange

None.

Request Formats

application/json, text/json

Sample: 
{
  "ProviderIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "Flags": [
    {
      "FlagName": "sample string 1",
      "FlagValue": "sample string 2"
    },
    {
      "FlagName": "sample string 1",
      "FlagValue": "sample string 2"
    }
  ],
  "WorkedDateRange": {
    "WorkedBeginDate": "2026-03-21T22:56:22.6213539+00:00",
    "WorkedEndDate": "2026-03-21T22:56:22.6213539+00:00"
  }
}

application/xml, text/xml

Sample: 
<GetRecentEarningsFiltersDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <Flags>
    <Flag>
      <FlagName>sample string 1</FlagName>
      <FlagValue>sample string 2</FlagValue>
    </Flag>
    <Flag>
      <FlagName>sample string 1</FlagName>
      <FlagValue>sample string 2</FlagValue>
    </Flag>
  </Flags>
  <ProviderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProviderIDs>
  <WorkedDateRange>
    <WorkedBeginDate>2026-03-21T22:56:22.6213539+00:00</WorkedBeginDate>
    <WorkedEndDate>2026-03-21T22:56:22.6213539+00:00</WorkedEndDate>
  </WorkedDateRange>
</GetRecentEarningsFiltersDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RecentEarningsSnapshotFilterResultDTO
NameDescriptionTypeAdditional information
Services

None.

Response Formats

application/json, text/json

Sample: 
{
  "Services": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "AuthorizationComment": "sample string 3",
      "ExternalReferenceId": "sample string 4"
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "AuthorizationComment": "sample string 3",
      "ExternalReferenceId": "sample string 4"
    }
  ],
  "PayPeriods": [
    {
      "PayPeriodStart": "2026-03-21T22:56:22.6213539+00:00",
      "PayPeriodEnd": "2026-03-21T22:56:22.6213539+00:00"
    },
    {
      "PayPeriodStart": "2026-03-21T22:56:22.6213539+00:00",
      "PayPeriodEnd": "2026-03-21T22:56:22.6213539+00:00"
    }
  ]
}

application/xml, text/xml

Sample: 
<RecentEarningsSnapshotFilterResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <PayPeriods>
    <PayPeriod>
      <PayPeriodEnd>2026-03-21T22:56:22.6213539+00:00</PayPeriodEnd>
      <PayPeriodStart>2026-03-21T22:56:22.6213539+00:00</PayPeriodStart>
    </PayPeriod>
    <PayPeriod>
      <PayPeriodEnd>2026-03-21T22:56:22.6213539+00:00</PayPeriodEnd>
      <PayPeriodStart>2026-03-21T22:56:22.6213539+00:00</PayPeriodStart>
    </PayPeriod>
  </PayPeriods>
  <Services>
    <Service>
      <AuthorizationComment>sample string 3</AuthorizationComment>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <ExternalReferenceId>sample string 4</ExternalReferenceId>
    </Service>
    <Service>
      <AuthorizationComment>sample string 3</AuthorizationComment>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <ExternalReferenceId>sample string 4</ExternalReferenceId>
    </Service>
  </Services>
</RecentEarningsSnapshotFilterResultDTO>