GET api/PayAdviceSummary

Get pay advice summary for a period.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

Name	Description	Type	Additional information
periodEndFrom Date	Period End from date	date	Required
periodEndToDate	Period End to date	date	Required
empCode	The employee code, optional	string	Default value is
page	Page number, default is 1.	integer	Default value is 1
pageSize	Page size, default is 10, maximum allowed is 100.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

PagedObjectOfPayAdviceSummaryView

Name	Description	Type	Additional information
Items		Collection of PayAdviceSummary View	None.
PageInfo		PagedListPageInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "payAdvicePDFId": 2,
      "empCode": "sample string 3",
      "payAdviceNumber": 4,
      "periodStart": "2025-01-18T16:17:41.1137789+11:00",
      "periodEnd": "2025-01-18T16:17:41.1137789+11:00",
      "payAdviceDate": "2025-01-18T16:17:41.1137789+11:00",
      "totalGross": 1.1,
      "totalSuper": 1.1,
      "totalTax": 1.1,
      "totalNet": 1.1,
      "dateCreated": "2025-01-18T16:17:41.1137789+11:00"
    },
    {
      "payAdvicePDFId": 2,
      "empCode": "sample string 3",
      "payAdviceNumber": 4,
      "periodStart": "2025-01-18T16:17:41.1137789+11:00",
      "periodEnd": "2025-01-18T16:17:41.1137789+11:00",
      "payAdviceDate": "2025-01-18T16:17:41.1137789+11:00",
      "totalGross": 1.1,
      "totalSuper": 1.1,
      "totalTax": 1.1,
      "totalNet": 1.1,
      "dateCreated": "2025-01-18T16:17:41.1137789+11:00"
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "countThisPage": 5,
    "hasPreviousPage": true,
    "hasNextPage": true,
    "errorMessage": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<PagedObjectOfPayAdviceSummaryView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PayAdviceSummaryView>
      <idPayAdviceSummary>1</idPayAdviceSummary>
      <PayAdvicePDFId>2</PayAdvicePDFId>
      <EmpCode>sample string 3</EmpCode>
      <PayAdviceNumber>4</PayAdviceNumber>
      <PeriodStart>2025-01-18T16:17:41.1137789+11:00</PeriodStart>
      <PeriodEnd>2025-01-18T16:17:41.1137789+11:00</PeriodEnd>
      <PayAdviceDate>2025-01-18T16:17:41.1137789+11:00</PayAdviceDate>
      <TotalGross>1.1</TotalGross>
      <TotalSuper>1.1</TotalSuper>
      <TotalTax>1.1</TotalTax>
      <TotalNet>1.1</TotalNet>
      <DateCreated>2025-01-18T16:17:41.1137789+11:00</DateCreated>
    </PayAdviceSummaryView>
    <PayAdviceSummaryView>
      <idPayAdviceSummary>1</idPayAdviceSummary>
      <PayAdvicePDFId>2</PayAdvicePDFId>
      <EmpCode>sample string 3</EmpCode>
      <PayAdviceNumber>4</PayAdviceNumber>
      <PeriodStart>2025-01-18T16:17:41.1137789+11:00</PeriodStart>
      <PeriodEnd>2025-01-18T16:17:41.1137789+11:00</PeriodEnd>
      <PayAdviceDate>2025-01-18T16:17:41.1137789+11:00</PayAdviceDate>
      <TotalGross>1.1</TotalGross>
      <TotalSuper>1.1</TotalSuper>
      <TotalTax>1.1</TotalTax>
      <TotalNet>1.1</TotalNet>
      <DateCreated>2025-01-18T16:17:41.1137789+11:00</DateCreated>
    </PayAdviceSummaryView>
  </Items>
  <PageInfo>
    <Page>1</Page>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
    <CountThisPage>5</CountThisPage>
    <HasPreviousPage>true</HasPreviousPage>
    <HasNextPage>true</HasNextPage>
    <ErrorMessage>sample string 8</ErrorMessage>
  </PageInfo>
</PagedObjectOfPayAdviceSummaryView>