GET v1/Employees/GetEmployeeDeductionsByEmployeeNumber/{employeeNumber}

Retrieves Employee Deduction by Employee Number

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNumber	The Employee Number.	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of EmployeeDeductionMetaData

Name	Description	Type	Additional information
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
EmployeeDeductionID	the Employee Deduction ID is the unique identifier for a deduction (required for UpdateEmployeeDeduction and DeleteEmployeeDeductions)	integer	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

Response 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": "2026-05-14T00:16:41.4801305-04:00",
    "EndDate": "2026-05-14T00:16:41.4801305-04:00",
    "PayeeReferenceNumber": "sample string 7",
    "ModifiedOn": "2026-05-14T00:16:41.4801305-04:00",
    "CatchUpAllowed": true
  },
  {
    "EmployeeNumber": "sample string 1",
    "DeductionType": "sample string 2",
    "DeductionDescription": "sample string 3",
    "EmployeeDeductionID": 4,
    "Rate": 5.0,
    "Amount": 6.0,
    "StartDate": "2026-05-14T00:16:41.4801305-04:00",
    "EndDate": "2026-05-14T00:16:41.4801305-04:00",
    "PayeeReferenceNumber": "sample string 7",
    "ModifiedOn": "2026-05-14T00:16:41.4801305-04:00",
    "CatchUpAllowed": true
  }
]

application/xml, text/xml

Sample:

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