GET v1/income-verification/export/companies/{companyCode}/deductions?includeInactive={includeInactive}

Retrieve Deductions by Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
includeInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ExportDeductionDTO

Name	Type	Additional information
DivisionKey	DivisionKeyDTO	None.
DeductionCode	string	None.
DeductionDescription	string	None.
DeductionType	string	None.
Frequency	string	None.
CalculationRule	DeductionCalcRule	None.
BasedOn	DeductionBasedOn	None.
IsActive	boolean	None.
MemoOnly	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "deductionCode": "sample string 1",
    "deductionDescription": "sample string 2",
    "deductionType": "sample string 3",
    "frequency": "sample string 4",
    "calculationRule": "Flat",
    "basedOn": "None",
    "isActive": true,
    "memoOnly": true
  },
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "deductionCode": "sample string 1",
    "deductionDescription": "sample string 2",
    "deductionType": "sample string 3",
    "frequency": "sample string 4",
    "calculationRule": "Flat",
    "basedOn": "None",
    "isActive": true,
    "memoOnly": true
  }
]

text/xml

Sample:

<ArrayOfExportDeductionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportDeductionDTO>
    <BasedOn>None</BasedOn>
    <CalculationRule>Flat</CalculationRule>
    <DeductionCode>sample string 1</DeductionCode>
    <DeductionDescription>sample string 2</DeductionDescription>
    <DeductionType>sample string 3</DeductionType>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <Frequency>sample string 4</Frequency>
    <IsActive>true</IsActive>
    <MemoOnly>true</MemoOnly>
  </ExportDeductionDTO>
  <ExportDeductionDTO>
    <BasedOn>None</BasedOn>
    <CalculationRule>Flat</CalculationRule>
    <DeductionCode>sample string 1</DeductionCode>
    <DeductionDescription>sample string 2</DeductionDescription>
    <DeductionType>sample string 3</DeductionType>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <Frequency>sample string 4</Frequency>
    <IsActive>true</IsActive>
    <MemoOnly>true</MemoOnly>
  </ExportDeductionDTO>
</ArrayOfExportDeductionDTO>