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

Update a Deduction for an Employee. Uses the record ID, along with Start Date and Pay Element as the key.

Request Information

URI Parameters

Name	Description	Type	Additional information
recordID	Employee Deduction Record ID	string	Required
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	AnnualAmount OR PeriodAmount is required	decimal number	None.
PeriodAmount	AnnualAmount OR PeriodAmount is required	decimal number	None.
Balance	The balance of the loan.	decimal number	None.
Applied	Retrieve only. Indicates whether the deduction record has been stamped with a period.	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>