GET v1/income-verification/export/companies/{companyCode}/employees?asOf={asOf}

Retrieve Employee Headers by Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
asOf		date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of IncomeVerificationEmployeeHeaderDTO

Name	Type	Additional information
SSN	string	None.
EmployeeStatus	EmployeeStatus	None.
HireDate	date	None.
TerminationDate	date	None.
RehireDate	date	None.
ClientCode	string	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ssn": "sample string 1",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "clientCode": "sample string 2",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 3"
  },
  {
    "ssn": "sample string 1",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "clientCode": "sample string 2",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 3"
  }
]

text/xml

Sample:

<ArrayOfIncomeVerificationEmployeeHeaderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <IncomeVerificationEmployeeHeaderDTO>
    <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 3</EmployeeNumber>
    <ClientCode>sample string 2</ClientCode>
    <EmployeeStatus>Active</EmployeeStatus>
    <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>
    <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 1</SSN>
    <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>
  </IncomeVerificationEmployeeHeaderDTO>
  <IncomeVerificationEmployeeHeaderDTO>
    <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 3</EmployeeNumber>
    <ClientCode>sample string 2</ClientCode>
    <EmployeeStatus>Active</EmployeeStatus>
    <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>
    <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 1</SSN>
    <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>
  </IncomeVerificationEmployeeHeaderDTO>
</ArrayOfIncomeVerificationEmployeeHeaderDTO>