GET v1/on-demand-pay/export/employee-scheduled-deductions?companyCode={companyCode}&divisionCode={divisionCode}&employeeNumber={employeeNumber}&optionalEffectiveDate={optionalEffectiveDate}&optionalDivisionDeductionCode={optionalDivisionDeductionCode}

Retrieve Filtered Scheduled Deductions by Division

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
divisionCode		string	Required
employeeNumber	If included, only the scheduled deductions by Employee will be returned. It can be filtered further by optionalEffectiveDate and optionalDivisionDeductionCode.	string	None.
optionalEffectiveDate		date	None.
optionalDivisionDeductionCode	If included, scheduled deductions by Employee will be filtered to just the specified code. Should only be included when the employeeNumber is also provided.	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of OnDemandPayScheduledDeductionDTO

Name	Type	Additional information
DeductionCode	string	None.
Amount	decimal number	None.
Rate	decimal number	None.
StartDate	date	None.
EndDate	date	None.
MinimumAmount	decimal number	None.
MaximumAmount	decimal number	None.
OtherMaxType	OtherMaximumType	None.
OtherMaxAmount	decimal number	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,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "minimumAmount": 1.0,
    "maximumAmount": 1.0,
    "otherMaxType": "None",
    "otherMaxAmount": 1.0,
    "useDivisionDefaults": true,
    "goalAmount": 1.0,
    "toDate": 1.0,
    "payeeCode": "sample string 4",
    "payeeReference": "sample string 5",
    "accumulatedArrears": 1.0,
    "isBlocked": true,
    "lastDeducted": "0001-02-03",
    "overrideMaxArrearsPercent": 1.0,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  },
  {
    "deductionCode": "sample string 1",
    "amount": 2.0,
    "rate": 3.0,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "minimumAmount": 1.0,
    "maximumAmount": 1.0,
    "otherMaxType": "None",
    "otherMaxAmount": 1.0,
    "useDivisionDefaults": true,
    "goalAmount": 1.0,
    "toDate": 1.0,
    "payeeCode": "sample string 4",
    "payeeReference": "sample string 5",
    "accumulatedArrears": 1.0,
    "isBlocked": true,
    "lastDeducted": "0001-02-03",
    "overrideMaxArrearsPercent": 1.0,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  }
]

text/xml

Sample:

<ArrayOfOnDemandPayScheduledDeductionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <OnDemandPayScheduledDeductionDTO>
    <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 6</EmployeeNumber>
    <AccumulatedArrears>1</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>1</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>1</MaximumAmount>
    <MinimumAmount>1</MinimumAmount>
    <OtherMaxAmount>1</OtherMaxAmount>
    <OtherMaxType>None</OtherMaxType>
    <OverrideMaxArrearsPercent>1</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 4</PayeeCode>
    <PayeeReference>sample string 5</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>1</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </OnDemandPayScheduledDeductionDTO>
  <OnDemandPayScheduledDeductionDTO>
    <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 6</EmployeeNumber>
    <AccumulatedArrears>1</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>1</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>1</MaximumAmount>
    <MinimumAmount>1</MinimumAmount>
    <OtherMaxAmount>1</OtherMaxAmount>
    <OtherMaxType>None</OtherMaxType>
    <OverrideMaxArrearsPercent>1</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 4</PayeeCode>
    <PayeeReference>sample string 5</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>1</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </OnDemandPayScheduledDeductionDTO>
</ArrayOfOnDemandPayScheduledDeductionDTO>