POST v1/Employees/AddEmployeeDeduction

Add Employee Deduction Information, parameter is Employee Deduction Object. Employee Number is the Data Key for proper updating

Request Information

URI Parameters

None.

Body Parameters

The EmployeeDeduction Object.

EmployeeDeductionAddRequest

Name	Description	Type	Additional information
EmployeeDeductionID	the Employee Deduction ID is the unique identifier for a deduction (not required for Add — auto-assigned)	integer	None.
EmployeeNumber		string	Required
DeductionType	the Deduction Type is used for the deduction code in the system	string	Required
DeductionDescription	the Deduction Description is used for the deduction code in the system	string	Required
Rate	the Rate is used for percentage deductions	decimal number	Required
Amount	the Amount is used for flat amount deductions	decimal number	Required
StartDate	the Start Date the deduction should take in effect	date	Required
EndDate	the End Date the deduction should take in effect	date	Required
PayeeReferenceNumber	the Reference Number if used for a loan deduction	string	None.
ModifiedOn		date	None.
CatchUpAllowed	Catchup flag for restricted users to set catchup deduction codes	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "EmployeeDeductionID": 1,
  "EmployeeNumber": "sample string 2",
  "DeductionType": "sample string 3",
  "DeductionDescription": "sample string 4",
  "Rate": 5.0,
  "Amount": 6.0,
  "StartDate": "2026-05-14T00:17:13.4987965-04:00",
  "EndDate": "2026-05-14T00:17:13.4987965-04:00",
  "PayeeReferenceNumber": "sample string 7",
  "ModifiedOn": "2026-05-14T00:17:13.4987965-04:00",
  "CatchUpAllowed": true
}

application/xml, text/xml

Sample:

<EmployeeDeductionAddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models.DTOs">
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">6</Amount>
  <CatchUpAllowed xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">true</CatchUpAllowed>
  <DeductionDescription xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">sample string 4</DeductionDescription>
  <DeductionType xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">sample string 3</DeductionType>
  <EmployeeDeductionID xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">0</EmployeeDeductionID>
  <EmployeeNumber xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">sample string 2</EmployeeNumber>
  <EndDate xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">2026-05-14T00:17:13.4987965-04:00</EndDate>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">2026-05-14T00:17:13.4987965-04:00</ModifiedOn>
  <PayeeReferenceNumber xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">sample string 7</PayeeReferenceNumber>
  <Rate xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">5</Rate>
  <StartDate xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">2026-05-14T00:17:13.4987965-04:00</StartDate>
  <EmployeeDeductionID>1</EmployeeDeductionID>
</EmployeeDeductionAddRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.