PUT api/Deductions
Puts the specified deduction.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
deduction | The deduction. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "DeductionCode": "sample string 1", "EmployeeId": 2, "CompanyCode": "sample string 3", "StatusCode": "sample string 4", "EmployeeDeductionPerPayrollAmount": 5.0, "EmployerDeductionPerPayrollAmount": 1.0, "EmployeeMaximumAnnualDeductionAmount": 1.0, "EmployerMaximumAnnualDeductionAmount": 1.0, "StartDate": "2024-11-04T10:53:49.2289052-06:00", "EndDate": "2024-11-04T10:53:49.2289052-06:00", "PayeeCode": "sample string 7", "Petitioner": "sample string 8", "CaseId": "sample string 9", "IsEmployerContributionCalculated": true }
application/xml, text/xml
Sample:
<Deduction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.API.External.Areas.Deductions.Models.External"> <CaseId>sample string 9</CaseId> <CompanyCode>sample string 3</CompanyCode> <DeductionCode>sample string 1</DeductionCode> <EmployeeDeductionPerPayrollAmount>5</EmployeeDeductionPerPayrollAmount> <EmployeeId>2</EmployeeId> <EmployeeMaximumAnnualDeductionAmount>1</EmployeeMaximumAnnualDeductionAmount> <EmployerDeductionPerPayrollAmount>1</EmployerDeductionPerPayrollAmount> <EmployerMaximumAnnualDeductionAmount>1</EmployerMaximumAnnualDeductionAmount> <EndDate>2024-11-04T10:53:49.2289052-06:00</EndDate> <IsEmployerContributionCalculated>true</IsEmployerContributionCalculated> <PayeeCode>sample string 7</PayeeCode> <Petitioner>sample string 8</Petitioner> <StartDate>2024-11-04T10:53:49.2289052-06:00</StartDate> <StatusCode>sample string 4</StatusCode> </Deduction>
Response Information
APIResult.
Response body formats
application/json, text/json
Sample:
{ "Success": true, "Messages": [ "sample string 1", "sample string 2", "sample string 3" ] }
application/xml, text/xml
Sample:
<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.External.API.Models.Simple"> <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> <d2p1:string>sample string 3</d2p1:string> </Messages> <Success>true</Success> </APIResult>