GET api/Deductions?employeeId={employeeId}

RESTfull Get Method to return all employee deduction records for a specific employee.

Request Information

Parameters

NameDescriptionAdditional information
employeeId
The employee identifier.

Define this parameter in the request URI.

Response Information

Response 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": "2022-07-02T10:12:45.574789-05:00",
    "EndDate": "2022-07-02T10:12:45.574789-05:00",
    "PayeeCode": "sample string 7",
    "Petitioner": "sample string 8",
    "CaseId": "sample string 9",
    "IsEmployerContributionCalculated": true
  },
  {
    "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": "2022-07-02T10:12:45.574789-05:00",
    "EndDate": "2022-07-02T10:12:45.574789-05:00",
    "PayeeCode": "sample string 7",
    "Petitioner": "sample string 8",
    "CaseId": "sample string 9",
    "IsEmployerContributionCalculated": true
  },
  {
    "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": "2022-07-02T10:12:45.574789-05:00",
    "EndDate": "2022-07-02T10:12:45.574789-05:00",
    "PayeeCode": "sample string 7",
    "Petitioner": "sample string 8",
    "CaseId": "sample string 9",
    "IsEmployerContributionCalculated": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfDeduction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netchex.API.External.Areas.Deductions.Models.External">
  <Deduction>
    <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>2022-07-02T10:12:45.574789-05:00</EndDate>
    <IsEmployerContributionCalculated>true</IsEmployerContributionCalculated>
    <PayeeCode>sample string 7</PayeeCode>
    <Petitioner>sample string 8</Petitioner>
    <StartDate>2022-07-02T10:12:45.574789-05:00</StartDate>
    <StatusCode>sample string 4</StatusCode>
  </Deduction>
  <Deduction>
    <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>2022-07-02T10:12:45.574789-05:00</EndDate>
    <IsEmployerContributionCalculated>true</IsEmployerContributionCalculated>
    <PayeeCode>sample string 7</PayeeCode>
    <Petitioner>sample string 8</Petitioner>
    <StartDate>2022-07-02T10:12:45.574789-05:00</StartDate>
    <StatusCode>sample string 4</StatusCode>
  </Deduction>
  <Deduction>
    <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>2022-07-02T10:12:45.574789-05:00</EndDate>
    <IsEmployerContributionCalculated>true</IsEmployerContributionCalculated>
    <PayeeCode>sample string 7</PayeeCode>
    <Petitioner>sample string 8</Petitioner>
    <StartDate>2022-07-02T10:12:45.574789-05:00</StartDate>
    <StatusCode>sample string 4</StatusCode>
  </Deduction>
</ArrayOfDeduction>