GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/direct-deposits

Retrieve Direct Deposits by Employee Number

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
employeeNumber	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeDirectDepositDTO

Name	Type	Additional information
TransABA	string	None.
AccountNumber	string	None.
DDCalculationType	DDCalculationType	None.
ACHAccountType	string	None.
Amount	decimal number	None.
Sequence	integer	None.
StartDate	date	None.
EndDate	date	None.
BlockOnAdditionalChecks	boolean	None.
PreNoteEndDate	date	None.
BankName	string	None.
IsInternal	boolean	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "transABA": "sample string 1",
    "accountNumber": "sample string 2",
    "ddCalculationType": "Flat",
    "achAccountType": "sample string 3",
    "amount": 4.0,
    "sequence": 5,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "blockOnAdditionalChecks": true,
    "preNoteEndDate": "0001-02-03",
    "bankName": "sample string 7",
    "isInternal": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 9"
  },
  {
    "transABA": "sample string 1",
    "accountNumber": "sample string 2",
    "ddCalculationType": "Flat",
    "achAccountType": "sample string 3",
    "amount": 4.0,
    "sequence": 5,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "blockOnAdditionalChecks": true,
    "preNoteEndDate": "0001-02-03",
    "bankName": "sample string 7",
    "isInternal": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 9"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeeDirectDepositDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeDirectDepositDTO>
    <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 9</EmployeeNumber>
    <ACHAccountType>sample string 3</ACHAccountType>
    <AccountNumber>sample string 2</AccountNumber>
    <Amount>4</Amount>
    <BankName>sample string 7</BankName>
    <BlockOnAdditionalChecks>true</BlockOnAdditionalChecks>
    <DDCalculationType>Flat</DDCalculationType>
    <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>
    <IsInternal>true</IsInternal>
    <PreNoteEndDate 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>
    </PreNoteEndDate>
    <Sequence>5</Sequence>
    <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>
    <TransABA>sample string 1</TransABA>
  </ExportEmployeeDirectDepositDTO>
  <ExportEmployeeDirectDepositDTO>
    <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 9</EmployeeNumber>
    <ACHAccountType>sample string 3</ACHAccountType>
    <AccountNumber>sample string 2</AccountNumber>
    <Amount>4</Amount>
    <BankName>sample string 7</BankName>
    <BlockOnAdditionalChecks>true</BlockOnAdditionalChecks>
    <DDCalculationType>Flat</DDCalculationType>
    <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>
    <IsInternal>true</IsInternal>
    <PreNoteEndDate 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>
    </PreNoteEndDate>
    <Sequence>5</Sequence>
    <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>
    <TransABA>sample string 1</TransABA>
  </ExportEmployeeDirectDepositDTO>
</ArrayOfExportEmployeeDirectDepositDTO>