GET api/Deduction/{employeeNo}/{payElement}/{startDate}

Get a specific deduction for an employee. The key is the PayElement and the StartDate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

payElement

Pay Element

string

Required

startDate

Start Date

date

Required

Body Parameters

None.

Response Information

Resource Description

Deduction

DeductionDetail
NameDescriptionTypeAdditional 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": 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:
<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>