GET api/Deductions?companyIds={companyIds}
RESTfull Get Method to return all employee deduction records for employees by company ids.
Request Information
Parameters
| Name | Description |
|---|---|
|
companyIds
(param in the URI) |
The company ids. |
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"DeductionCode": "",
"EmployeeId": 0,
"CompanyCode": "",
"StatusCode": "",
"EmployeeDeductionPerPayrollAmount": 0.0,
"EmployerDeductionPerPayrollAmount": 0.0,
"EmployeeMaximumAnnualDeductionAmount": 0.0,
"EmployerMaximumAnnualDeductionAmount": 0.0,
"StartDate": "2000-01-01T00:00:00",
"EndDate": "2000-01-01T00:00:00",
"PayeeCode": "",
"Petitioner": "",
"CaseId": "",
"IsEmployerContributionCalculated": false
},
{
"DeductionCode": "",
"EmployeeId": 0,
"CompanyCode": "",
"StatusCode": "",
"EmployeeDeductionPerPayrollAmount": 0.0,
"EmployerDeductionPerPayrollAmount": 0.0,
"EmployeeMaximumAnnualDeductionAmount": 0.0,
"EmployerMaximumAnnualDeductionAmount": 0.0,
"StartDate": "2000-01-01T00:00:00",
"EndDate": "2000-01-01T00:00:00",
"PayeeCode": "",
"Petitioner": "",
"CaseId": "",
"IsEmployerContributionCalculated": false
},
{
"DeductionCode": "",
"EmployeeId": 0,
"CompanyCode": "",
"StatusCode": "",
"EmployeeDeductionPerPayrollAmount": 0.0,
"EmployerDeductionPerPayrollAmount": 0.0,
"EmployeeMaximumAnnualDeductionAmount": 0.0,
"EmployerMaximumAnnualDeductionAmount": 0.0,
"StartDate": "2000-01-01T00:00:00",
"EndDate": "2000-01-01T00:00:00",
"PayeeCode": "",
"Petitioner": "",
"CaseId": "",
"IsEmployerContributionCalculated": false
}
]
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></CaseId>
<CompanyCode></CompanyCode>
<DeductionCode></DeductionCode>
<EmployeeDeductionPerPayrollAmount>0</EmployeeDeductionPerPayrollAmount>
<EmployeeId>0</EmployeeId>
<EmployeeMaximumAnnualDeductionAmount>0</EmployeeMaximumAnnualDeductionAmount>
<EmployerDeductionPerPayrollAmount>0</EmployerDeductionPerPayrollAmount>
<EmployerMaximumAnnualDeductionAmount>0</EmployerMaximumAnnualDeductionAmount>
<EndDate>2000-01-01T00:00:00</EndDate>
<IsEmployerContributionCalculated>false</IsEmployerContributionCalculated>
<PayeeCode></PayeeCode>
<Petitioner></Petitioner>
<StartDate>2000-01-01T00:00:00</StartDate>
<StatusCode></StatusCode>
</Deduction>
<Deduction>
<CaseId></CaseId>
<CompanyCode></CompanyCode>
<DeductionCode></DeductionCode>
<EmployeeDeductionPerPayrollAmount>0</EmployeeDeductionPerPayrollAmount>
<EmployeeId>0</EmployeeId>
<EmployeeMaximumAnnualDeductionAmount>0</EmployeeMaximumAnnualDeductionAmount>
<EmployerDeductionPerPayrollAmount>0</EmployerDeductionPerPayrollAmount>
<EmployerMaximumAnnualDeductionAmount>0</EmployerMaximumAnnualDeductionAmount>
<EndDate>2000-01-01T00:00:00</EndDate>
<IsEmployerContributionCalculated>false</IsEmployerContributionCalculated>
<PayeeCode></PayeeCode>
<Petitioner></Petitioner>
<StartDate>2000-01-01T00:00:00</StartDate>
<StatusCode></StatusCode>
</Deduction>
<Deduction>
<CaseId></CaseId>
<CompanyCode></CompanyCode>
<DeductionCode></DeductionCode>
<EmployeeDeductionPerPayrollAmount>0</EmployeeDeductionPerPayrollAmount>
<EmployeeId>0</EmployeeId>
<EmployeeMaximumAnnualDeductionAmount>0</EmployeeMaximumAnnualDeductionAmount>
<EmployerDeductionPerPayrollAmount>0</EmployerDeductionPerPayrollAmount>
<EmployerMaximumAnnualDeductionAmount>0</EmployerMaximumAnnualDeductionAmount>
<EndDate>2000-01-01T00:00:00</EndDate>
<IsEmployerContributionCalculated>false</IsEmployerContributionCalculated>
<PayeeCode></PayeeCode>
<Petitioner></Petitioner>
<StartDate>2000-01-01T00:00:00</StartDate>
<StatusCode></StatusCode>
</Deduction>
</ArrayOfDeduction>