GET v1/on-demand-pay/export/employees?companyCode={companyCode}&divisionCode={divisionCode}&asOf={asOf}&rangeStart={rangeStart}&rangeEnd={rangeEnd}

Retrieve OnDemandPay Employees by Division

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

The company code.

 string

Required
divisionCode

The division code.

 string

Required
asOf

date

None.
rangeStart

The start of the range of modified dates for which to return employees.

 date

None.
rangeEnd

The end of the range of modified dates for which to return employees.

 date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OnDemandPayEmployeeDTO
NameDescriptionTypeAdditional information
EmployeeNumber

string

None.
EmployeeKey

GlobalEntityKeyOfIEmployee

None.
LastName

string

None.
FirstName

string

None.
MiddleInitial

character

None.
SSN

string

None.
BirthDate

date

None.
EmployeeStatus

EmployeeStatus

None.
HireDate

date

None.
RehireDate

date

None.
TerminationDate

date

None.
BaseRate

decimal number

None.
PayType

PayType

None.
PayFrequency

PayFrequency

None.
StandardHours

decimal number

None.
ClockNumber

string

None.
WorkPhone

string

None.
WorkExtension

string

None.
HomePhone

string

None.
MobilePhone

string

None.
Email

string

None.
Department

string

None.
LocationCode

string

None.
PersonalId

EntityKeyOfIEmployeePersonalAndInt32

None.
DirectDeposits

Collection of OnDemandPayDirectDepositDTO

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "employeeNumber": "sample string 1",
    "employeeKey": "<empty>",
    "lastName": "sample string 2",
    "firstName": "sample string 3",
    "middleInitial": "A",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "baseRate": 6.0,
    "payType": "Salary",
    "payFrequency": "YEAR",
    "standardHours": 1.0,
    "clockNumber": "sample string 7",
    "workPhone": "sample string 8",
    "workExtension": "sample string 9",
    "homePhone": "sample string 10",
    "mobilePhone": "sample string 11",
    "email": "sample string 12",
    "department": "sample string 13",
    "locationCode": "sample string 14",
    "personalId": "<empty>",
    "directDeposits": [
      {
        "accountNumberLast4Digits": "sample string 1",
        "transABA": "sample string 2",
        "achAccountTypeCode": "sample string 3",
        "achAccountType": "Savings"
      },
      {
        "accountNumberLast4Digits": "sample string 1",
        "transABA": "sample string 2",
        "achAccountTypeCode": "sample string 3",
        "achAccountType": "Savings"
      }
    ]
  },
  {
    "employeeNumber": "sample string 1",
    "employeeKey": "<empty>",
    "lastName": "sample string 2",
    "firstName": "sample string 3",
    "middleInitial": "A",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "baseRate": 6.0,
    "payType": "Salary",
    "payFrequency": "YEAR",
    "standardHours": 1.0,
    "clockNumber": "sample string 7",
    "workPhone": "sample string 8",
    "workExtension": "sample string 9",
    "homePhone": "sample string 10",
    "mobilePhone": "sample string 11",
    "email": "sample string 12",
    "department": "sample string 13",
    "locationCode": "sample string 14",
    "personalId": "<empty>",
    "directDeposits": [
      {
        "accountNumberLast4Digits": "sample string 1",
        "transABA": "sample string 2",
        "achAccountTypeCode": "sample string 3",
        "achAccountType": "Savings"
      },
      {
        "accountNumberLast4Digits": "sample string 1",
        "transABA": "sample string 2",
        "achAccountTypeCode": "sample string 3",
        "achAccountType": "Savings"
      }
    ]
  }
]

text/xml

Sample: 
<ArrayOfOnDemandPayEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <OnDemandPayEmployeeDTO>
    <BaseRate>6</BaseRate>
    <BirthDate 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>
    </BirthDate>
    <ClockNumber>sample string 7</ClockNumber>
    <Department>sample string 13</Department>
    <DirectDeposits>
      <OnDemandPayDirectDepositDTO>
        <ACHAccountType>Savings</ACHAccountType>
        <ACHAccountTypeCode>sample string 3</ACHAccountTypeCode>
        <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
        <TransABA>sample string 2</TransABA>
      </OnDemandPayDirectDepositDTO>
      <OnDemandPayDirectDepositDTO>
        <ACHAccountType>Savings</ACHAccountType>
        <ACHAccountTypeCode>sample string 3</ACHAccountTypeCode>
        <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
        <TransABA>sample string 2</TransABA>
      </OnDemandPayDirectDepositDTO>
    </DirectDeposits>
    <Email>sample string 12</Email>
    <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 1</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <FirstName>sample string 3</FirstName>
    <HireDate 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>
    </HireDate>
    <HomePhone>sample string 10</HomePhone>
    <LastName>sample string 2</LastName>
    <LocationCode>sample string 14</LocationCode>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 11</MobilePhone>
    <PayFrequency>YEAR</PayFrequency>
    <PayType>Salary</PayType>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <RehireDate 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>
    </RehireDate>
    <SSN>sample string 5</SSN>
    <StandardHours>1</StandardHours>
    <TerminationDate 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>
    </TerminationDate>
    <WorkExtension>sample string 9</WorkExtension>
    <WorkPhone>sample string 8</WorkPhone>
  </OnDemandPayEmployeeDTO>
  <OnDemandPayEmployeeDTO>
    <BaseRate>6</BaseRate>
    <BirthDate 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>
    </BirthDate>
    <ClockNumber>sample string 7</ClockNumber>
    <Department>sample string 13</Department>
    <DirectDeposits>
      <OnDemandPayDirectDepositDTO>
        <ACHAccountType>Savings</ACHAccountType>
        <ACHAccountTypeCode>sample string 3</ACHAccountTypeCode>
        <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
        <TransABA>sample string 2</TransABA>
      </OnDemandPayDirectDepositDTO>
      <OnDemandPayDirectDepositDTO>
        <ACHAccountType>Savings</ACHAccountType>
        <ACHAccountTypeCode>sample string 3</ACHAccountTypeCode>
        <AccountNumberLast4Digits>sample string 1</AccountNumberLast4Digits>
        <TransABA>sample string 2</TransABA>
      </OnDemandPayDirectDepositDTO>
    </DirectDeposits>
    <Email>sample string 12</Email>
    <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 1</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <FirstName>sample string 3</FirstName>
    <HireDate 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>
    </HireDate>
    <HomePhone>sample string 10</HomePhone>
    <LastName>sample string 2</LastName>
    <LocationCode>sample string 14</LocationCode>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 11</MobilePhone>
    <PayFrequency>YEAR</PayFrequency>
    <PayType>Salary</PayType>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <RehireDate 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>
    </RehireDate>
    <SSN>sample string 5</SSN>
    <StandardHours>1</StandardHours>
    <TerminationDate 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>
    </TerminationDate>
    <WorkExtension>sample string 9</WorkExtension>
    <WorkPhone>sample string 8</WorkPhone>
  </OnDemandPayEmployeeDTO>
</ArrayOfOnDemandPayEmployeeDTO>