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.

EmployeeDeductionMetaData
NameDescriptionTypeAdditional information
EmployeeNumber

string

None.

DeductionType

the Deduction Type is used for the deduction code in the system

string

None.

DeductionDescription

the Deduction Description is used for the deduction code in the system

string

None.

EmployeeDeductionID

the Employee Deduction ID is the unique identifier for a deduction

integer

None.

Rate

the Rate is used for percentage deductions

decimal number

None.

Amount

the Amount is used for flat amount deductions

decimal number

None.

StartDate

the Start Date the deduction should take in effect

date

None.

EndDate

the End Date the deduction should take in effect

date

None.

PayeeReferenceNumber

the Reference Number if used for a loan deduction

string

None.

ModifiedOn

date

None.

Request Formats

application/json, text/json

Sample:
{
  "EmployeeNumber": "sample string 1",
  "DeductionType": "sample string 2",
  "DeductionDescription": "sample string 3",
  "EmployeeDeductionID": 4,
  "Rate": 5.0,
  "Amount": 6.0,
  "StartDate": "2024-04-24T15:24:50.4730237-04:00",
  "EndDate": "2024-04-24T15:24:50.4730237-04:00",
  "PayeeReferenceNumber": "sample string 7",
  "ModifiedOn": "2024-04-24T15:24:50.4730237-04:00"
}

application/xml, text/xml

Sample:
<EmployeeDeductionMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <Amount>6</Amount>
  <DeductionDescription>sample string 3</DeductionDescription>
  <DeductionType>sample string 2</DeductionType>
  <EmployeeDeductionID>4</EmployeeDeductionID>
  <EmployeeNumber>sample string 1</EmployeeNumber>
  <EndDate>2024-04-24T15:24:50.4730237-04:00</EndDate>
  <ModifiedOn>2024-04-24T15:24:50.4730237-04:00</ModifiedOn>
  <PayeeReferenceNumber>sample string 7</PayeeReferenceNumber>
  <Rate>5</Rate>
  <StartDate>2024-04-24T15:24:50.4730237-04:00</StartDate>
</EmployeeDeductionMetaData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.