GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/scheduled-deductions?effectiveDate={effectiveDate}&divisionDeductionCode={divisionDeductionCode}

Retrieve Scheduled Deduction by Employee Number

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
employeeNumber	string	Required
effectiveDate	date	None.
divisionDeductionCode	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ExportScheduledDeductionDTO

Name	Type	Additional information
DeductionCode	string	None.
Amount	decimal number	None.
Rate	decimal number	None.
MinimumAmount	decimal number	None.
MaximumAmount	decimal number	None.
OtherMaxType	OtherMaximumType	None.
OtherMaxAmount	decimal number	None.
StartDate	date	None.
EndDate	date	None.
UseDivisionDefaults	boolean	None.
GoalAmount	decimal number	None.
ToDate	decimal number	None.
PayeeCode	string	None.
PayeeReference	string	None.
AccumulatedArrears	decimal number	None.
IsBlocked	boolean	None.
LastDeducted	date	None.
OverrideMaxArrearsPercent	decimal number	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "deductionCode": "sample string 1",
    "amount": 2.0,
    "rate": 3.0,
    "minimumAmount": 4.0,
    "maximumAmount": 5.0,
    "otherMaxType": "None",
    "otherMaxAmount": 6.0,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "useDivisionDefaults": true,
    "goalAmount": 8.0,
    "toDate": 9.0,
    "payeeCode": "sample string 10",
    "payeeReference": "sample string 11",
    "accumulatedArrears": 12.0,
    "isBlocked": true,
    "lastDeducted": "0001-02-03",
    "overrideMaxArrearsPercent": 14.0,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 15"
  },
  {
    "deductionCode": "sample string 1",
    "amount": 2.0,
    "rate": 3.0,
    "minimumAmount": 4.0,
    "maximumAmount": 5.0,
    "otherMaxType": "None",
    "otherMaxAmount": 6.0,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "useDivisionDefaults": true,
    "goalAmount": 8.0,
    "toDate": 9.0,
    "payeeCode": "sample string 10",
    "payeeReference": "sample string 11",
    "accumulatedArrears": 12.0,
    "isBlocked": true,
    "lastDeducted": "0001-02-03",
    "overrideMaxArrearsPercent": 14.0,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 15"
  }
]

text/xml

Sample:

<ArrayOfExportScheduledDeductionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportScheduledDeductionDTO>
    <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>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 15</EmployeeNumber>
    <AccumulatedArrears>12</AccumulatedArrears>
    <Amount>2</Amount>
    <DeductionCode>sample string 1</DeductionCode>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </EndDate>
    <GoalAmount>8</GoalAmount>
    <IsBlocked>true</IsBlocked>
    <LastDeducted xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </LastDeducted>
    <MaximumAmount>5</MaximumAmount>
    <MinimumAmount>4</MinimumAmount>
    <OtherMaxAmount>6</OtherMaxAmount>
    <OtherMaxType>None</OtherMaxType>
    <OverrideMaxArrearsPercent>14</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 10</PayeeCode>
    <PayeeReference>sample string 11</PayeeReference>
    <Rate>3</Rate>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </StartDate>
    <ToDate>9</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </ExportScheduledDeductionDTO>
  <ExportScheduledDeductionDTO>
    <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>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 15</EmployeeNumber>
    <AccumulatedArrears>12</AccumulatedArrears>
    <Amount>2</Amount>
    <DeductionCode>sample string 1</DeductionCode>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </EndDate>
    <GoalAmount>8</GoalAmount>
    <IsBlocked>true</IsBlocked>
    <LastDeducted xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </LastDeducted>
    <MaximumAmount>5</MaximumAmount>
    <MinimumAmount>4</MinimumAmount>
    <OtherMaxAmount>6</OtherMaxAmount>
    <OtherMaxType>None</OtherMaxType>
    <OverrideMaxArrearsPercent>14</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 10</PayeeCode>
    <PayeeReference>sample string 11</PayeeReference>
    <Rate>3</Rate>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </StartDate>
    <ToDate>9</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </ExportScheduledDeductionDTO>
</ArrayOfExportScheduledDeductionDTO>