GET api/PaymentSummaryPDF

Get list payment summaries pdf

Request Information

URI Parameters

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

Name	Description	Type	Additional information
financialYear	Financial year.	integer	Required
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

A list of payment summaries PDF.

PagedObjectOfPaymentSummaryPDFView

Name	Description	Type	Additional information
Items		Collection of PaymentSummaryP DFView	None.
PageInfo		PagedListPageInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "idPaymentSummaryPDF": 1,
      "empCode": "sample string 2",
      "periodEnd": "2024-12-04T19:07:29.2007834+11:00",
      "dateCreated": "2024-12-04T19:07:29.2007834+11:00",
      "pdfType": "sample string 5",
      "pdfName": "sample string 6",
      "pdfContents": "QEA="
    },
    {
      "idPaymentSummaryPDF": 1,
      "empCode": "sample string 2",
      "periodEnd": "2024-12-04T19:07:29.2007834+11:00",
      "dateCreated": "2024-12-04T19:07:29.2007834+11:00",
      "pdfType": "sample string 5",
      "pdfName": "sample string 6",
      "pdfContents": "QEA="
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 2,
    "totalCount": 3,
    "totalPages": 4,
    "countThisPage": 5,
    "hasPreviousPage": true,
    "hasNextPage": true,
    "errorMessage": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<PagedObjectOfPaymentSummaryPDFView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PaymentSummaryPDFView>
      <idPaymentSummaryPDF>1</idPaymentSummaryPDF>
      <EmpCode>sample string 2</EmpCode>
      <PeriodEnd>2024-12-04T19:07:29.2007834+11:00</PeriodEnd>
      <DateCreated>2024-12-04T19:07:29.2007834+11:00</DateCreated>
      <PDFType>sample string 5</PDFType>
      <PDFName>sample string 6</PDFName>
      <PDFContents>QEA=</PDFContents>
    </PaymentSummaryPDFView>
    <PaymentSummaryPDFView>
      <idPaymentSummaryPDF>1</idPaymentSummaryPDF>
      <EmpCode>sample string 2</EmpCode>
      <PeriodEnd>2024-12-04T19:07:29.2007834+11:00</PeriodEnd>
      <DateCreated>2024-12-04T19:07:29.2007834+11:00</DateCreated>
      <PDFType>sample string 5</PDFType>
      <PDFName>sample string 6</PDFName>
      <PDFContents>QEA=</PDFContents>
    </PaymentSummaryPDFView>
  </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>
</PagedObjectOfPaymentSummaryPDFView>