GET api/PaymentSummaryData

Get payment summaries data

Request Information

URI Parameters

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

Name	Description	Type	Additional information
financialYear From	Financial year from.	integer	Required
financialYearTo	Financial year to.	integer	Required
empCode	Employee code.	string	None.
page	Page number, default is 1.	integer	None.
pageSize	Page size, default is 10, maximum allowed is 100.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Payment summaries data.

PaymentSummaryDataView

Name	Type	Additional information
EmpCode	string	None.
FirstName	string	None.
SecondName	string	None.
Surname	string	None.
DateOfBirth	date	None.
Address1	string	None.
Suburb	string	None.
State	string	None.
PostCode	integer	None.
Country	string	None.
FinancialYear	integer	None.
PDFType	string	None.
Period PaymentEnd	date	None.
TFN	string	None.
PSType	integer	None.
GrossPayments	integer	None.
TotalTax	integer	None.
TotalAllowances	integer	None.
LumpSumA	integer	None.
LumpSumB	integer	None.
LumpSumD	integer	None.
LumpSumE	integer	None.
CDEP	integer	None.
OtherIncome	integer	None.
ReportableFB	integer	None.
WitholdingRate	integer	None.
NonCashBenefit	integer	None.
PreJuly83Days	integer	None.
PostJune83Days	integer	None.
PreJuly83	integer	None.
PostJune83	integer	None.
PostJune94	integer	None.
Assessable Amount	integer	None.
DeathBenefit	string	None.
DeathBenefit Type	string	None.
ATOFileCreated	boolean	None.
LHPaymentType	string	None.
Union Description	string	None.
Union	integer	None.
WorkplaceGiving Desc	string	None.
WorkplaceGiving	integer	None.
AustTotalTax	integer	None.
ETPPaymentCode	integer	None.
Export	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "empCode": "sample string 2",
  "firstName": "sample string 3",
  "secondName": "sample string 4",
  "surname": "sample string 5",
  "dateOfBirth": "2024-11-21T20:27:04.1971182+11:00",
  "address1": "sample string 7",
  "suburb": "sample string 8",
  "state": "sample string 9",
  "postCode": 10,
  "country": "sample string 11",
  "financialYear": 12,
  "pdfType": "sample string 13",
  "periodPaymentEnd": "2024-11-21T20:27:04.1971182+11:00",
  "tfn": "sample string 15",
  "psType": 16,
  "grossPayments": 17,
  "totalTax": 18,
  "totalAllowances": 19,
  "lumpSumA": 20,
  "lumpSumB": 21,
  "lumpSumD": 22,
  "lumpSumE": 23,
  "cdep": 24,
  "otherIncome": 25,
  "reportableFB": 26,
  "witholdingRate": 27,
  "nonCashBenefit": 28,
  "preJuly83Days": 29,
  "postJune83Days": 30,
  "preJuly83": 31,
  "postJune83": 32,
  "postJune94": 33,
  "assessableAmount": 34,
  "deathBenefit": "sample string 35",
  "deathBenefitType": "sample string 36",
  "atoFileCreated": true,
  "lhPaymentType": "sample string 38",
  "unionDescription": "sample string 39",
  "union": 40,
  "workplaceGivingDesc": "sample string 41",
  "workplaceGiving": 42,
  "austTotalTax": 43,
  "etpPaymentCode": 44,
  "export": 45
}

application/xml, text/xml

Sample:

<PaymentSummaryDataView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <idPSEmployee>1</idPSEmployee>
  <EmpCode>sample string 2</EmpCode>
  <FirstName>sample string 3</FirstName>
  <SecondName>sample string 4</SecondName>
  <Surname>sample string 5</Surname>
  <DateOfBirth>2024-11-21T20:27:04.1971182+11:00</DateOfBirth>
  <Address1>sample string 7</Address1>
  <Suburb>sample string 8</Suburb>
  <State>sample string 9</State>
  <PostCode>10</PostCode>
  <Country>sample string 11</Country>
  <FinancialYear>12</FinancialYear>
  <PDFType>sample string 13</PDFType>
  <PeriodPaymentEnd>2024-11-21T20:27:04.1971182+11:00</PeriodPaymentEnd>
  <TFN>sample string 15</TFN>
  <PSType>16</PSType>
  <GrossPayments>17</GrossPayments>
  <TotalTax>18</TotalTax>
  <TotalAllowances>19</TotalAllowances>
  <LumpSumA>20</LumpSumA>
  <LumpSumB>21</LumpSumB>
  <LumpSumD>22</LumpSumD>
  <LumpSumE>23</LumpSumE>
  <CDEP>24</CDEP>
  <OtherIncome>25</OtherIncome>
  <ReportableFB>26</ReportableFB>
  <WitholdingRate>27</WitholdingRate>
  <NonCashBenefit>28</NonCashBenefit>
  <PreJuly83Days>29</PreJuly83Days>
  <PostJune83Days>30</PostJune83Days>
  <PreJuly83>31</PreJuly83>
  <PostJune83>32</PostJune83>
  <PostJune94>33</PostJune94>
  <AssessableAmount>34</AssessableAmount>
  <DeathBenefit>sample string 35</DeathBenefit>
  <DeathBenefitType>sample string 36</DeathBenefitType>
  <ATOFileCreated>true</ATOFileCreated>
  <LHPaymentType>sample string 38</LHPaymentType>
  <UnionDescription>sample string 39</UnionDescription>
  <Union>40</Union>
  <WorkplaceGivingDesc>sample string 41</WorkplaceGivingDesc>
  <WorkplaceGiving>42</WorkplaceGiving>
  <AustTotalTax>43</AustTotalTax>
  <ETPPaymentCode>44</ETPPaymentCode>
  <Export>45</Export>
</PaymentSummaryDataView>