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

Update a Deduction for an Employee. The key for updates is the Pay Element and the Start Date

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required
payElement	Pay Element	string	Required
startDate	Start Date	date	Required

Body Parameters

In request Body: Employee Deduction Details

DeductionDetail

Name	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.

Request 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,
    "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>
    <RecordID>1140</RecordID>
    <StartDate>2022-02-01T00:00:00</StartDate>
</DeductionDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

ResultWithMessage

Name	Description	Type	Additional information
result	'OK', 'Error'	string	None.
message	Returns if result is Error	string	None.
returnValue		string	None.

Response Formats

application/json, text/json

Sample:

{
    "result": "OK"
}

{
    "result": "Error",
    "message": "Unable to save: the..."
}

application/xml, text/xml

Sample:

<ResultWithMessage>
    <result>OK</result>
</ResultWithMessage>

<ResultWithMessage>  
    <result>Error</result>
    <message>Unable to save: the...</message>
</ResultWithMessage>