GET api/Deduction/{employeeNo}
Get a list of all deductions for an employee
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
All Deduction Details
Collection of DeductionDetailName | Description | Type | Additional information |
---|---|---|---|
RecordID | integer |
None. |
|
PayElement |
Must not be archived |
string |
Required |
StartDate | date |
Required |
|
EndDate |
Must be before StartDate if present |
date |
None. |
AnnualAmount |
AmountAmount OR PeriodAmount is required |
decimal number |
None. |
PeriodAmount |
AmountAmount OR PeriodAmount is required |
decimal number |
None. |
Balance | decimal number |
None. |
|
Applied | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "RecordID": 1141, "PayElement": "Advance", "StartDate": "2022-02-02T00:00:00", "EndDate": "2022-02-03T00:00:00", "AnnualAmount": 600.0, "PeriodAmount": 50.0, "Balance": null, "Applied": false }, { "RecordID": 1140, "PayElement": "DEDUCTIONELEM", "StartDate": "2022-02-01T00:00:00", "EndDate": "2022-02-05T00:00:00", "AnnualAmount": 200.0, "PeriodAmount": 16.66, "Balance": null, "Applied": false } ]
application/xml, text/xml
Sample:
<ArrayOfDeductionDetail> <DeductionDetail> <AnnualAmount>200.0</AnnualAmount> <Applied>false</Applied> <Balance>null</Balance> <EndDate>2022-02-05T00:00:00</EndDate> <PayElement>DEDUCTIONELEM</PayElement> <PeriodAmount>16.66</PeriodAmount> <RecordID>1140</RecordID> <StartDate>2022-02-01T00:00:00</StartDate> </DeductionDetail> <DeductionDetail> <AnnualAmount>600.0</AnnualAmount> <Applied>false</Applied> <Balance>null</Balance> <EndDate>2022-02-03T00:00:00</EndDate> <PayElement>Advance</PayElement> <PeriodAmount>50.0</PeriodAmount> <RecordID>1141</RecordID> <StartDate>2022-02-02T00:00:00</StartDate> </DeductionDetail> </ArrayOfDeductionDetail>