POST v1/income-verification/export/clients/{clientCode}/employees

Retrieve Employees by SSN by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IncomeVerificationEmployeeDTO

Name	Type	Additional information
CompanyName	string	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeNumber	string	None.
PersonalId	integer	None.
LastName	string	None.
FirstName	string	None.
MiddleInitial	character	None.
SSN	string	None.
BirthDate	date	None.
EmployeeStatus	EmployeeStatus	None.
EmployeeStatusCode	string	None.
EmployeeStatusDescription	string	None.
RecordType	EmployeeRecordType	None.
FullOrPartTime	FullOrPartTime	None.
TaxType	EETaxType	None.
OriginalHireDate	date	None.
RehireDate	date	None.
HireDate	date	None.
TerminationDate	date	None.
TerminationReason	string	None.
PayGroup	string	None.
JobCode	string	None.
JobDescription	string	None.
JobTitle	string	None.
BaseRate	decimal number	None.
PayType	PayType	None.
PayFrequency	string	None.
StandardHours	decimal number	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
County	string	None.
Country	string	None.
DateOfBirth	date	None.
Gender	Gender	None.
WorkPhone	string	None.
HomePhone	string	None.
MobilePhone	string	None.
Email	string	None.
IsPrimary	boolean	None.
CostCenters	Collection of IncomeVerificationCostCenterDTO	None.
BenefitSeniorityDate	date	None.
LocationCode	string	None.
LocationDescription	string	None.
PositionCode	string	None.
NotEligibleForRehire	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "companyName": "sample string 1",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeNumber": "sample string 2",
    "personalId": 3,
    "lastName": "sample string 4",
    "firstName": "sample string 5",
    "middleInitial": "A",
    "ssn": "sample string 7",
    "birthDate": "0001-02-03",
    "employeeStatus": "Active",
    "employeeStatusCode": "sample string 8",
    "employeeStatusDescription": "sample string 9",
    "recordType": "Employee",
    "fullOrPartTime": "FullTime",
    "taxType": "W2",
    "originalHireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "terminationReason": "sample string 10",
    "payGroup": "sample string 11",
    "jobCode": "sample string 12",
    "jobDescription": "sample string 13",
    "jobTitle": "sample string 14",
    "baseRate": 15.0,
    "payType": "Salary",
    "payFrequency": "sample string 16",
    "standardHours": 1.0,
    "addressLine1": "sample string 17",
    "addressLine2": "sample string 18",
    "city": "sample string 19",
    "state": "sample string 20",
    "zipCode": "sample string 21",
    "county": "sample string 22",
    "country": "sample string 23",
    "dateOfBirth": "0001-02-03",
    "gender": "Male",
    "workPhone": "sample string 24",
    "homePhone": "sample string 25",
    "mobilePhone": "sample string 26",
    "email": "sample string 27",
    "isPrimary": true,
    "costCenters": [
      {
        "level": 1,
        "costCenterDescription": "sample string 2"
      },
      {
        "level": 1,
        "costCenterDescription": "sample string 2"
      }
    ],
    "benefitSeniorityDate": "0001-02-03",
    "locationCode": "sample string 29",
    "locationDescription": "sample string 30",
    "positionCode": "sample string 31",
    "notEligibleForRehire": true
  },
  {
    "companyName": "sample string 1",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeNumber": "sample string 2",
    "personalId": 3,
    "lastName": "sample string 4",
    "firstName": "sample string 5",
    "middleInitial": "A",
    "ssn": "sample string 7",
    "birthDate": "0001-02-03",
    "employeeStatus": "Active",
    "employeeStatusCode": "sample string 8",
    "employeeStatusDescription": "sample string 9",
    "recordType": "Employee",
    "fullOrPartTime": "FullTime",
    "taxType": "W2",
    "originalHireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "terminationReason": "sample string 10",
    "payGroup": "sample string 11",
    "jobCode": "sample string 12",
    "jobDescription": "sample string 13",
    "jobTitle": "sample string 14",
    "baseRate": 15.0,
    "payType": "Salary",
    "payFrequency": "sample string 16",
    "standardHours": 1.0,
    "addressLine1": "sample string 17",
    "addressLine2": "sample string 18",
    "city": "sample string 19",
    "state": "sample string 20",
    "zipCode": "sample string 21",
    "county": "sample string 22",
    "country": "sample string 23",
    "dateOfBirth": "0001-02-03",
    "gender": "Male",
    "workPhone": "sample string 24",
    "homePhone": "sample string 25",
    "mobilePhone": "sample string 26",
    "email": "sample string 27",
    "isPrimary": true,
    "costCenters": [
      {
        "level": 1,
        "costCenterDescription": "sample string 2"
      },
      {
        "level": 1,
        "costCenterDescription": "sample string 2"
      }
    ],
    "benefitSeniorityDate": "0001-02-03",
    "locationCode": "sample string 29",
    "locationDescription": "sample string 30",
    "positionCode": "sample string 31",
    "notEligibleForRehire": true
  }
]

text/xml

Sample:

<ArrayOfIncomeVerificationEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <IncomeVerificationEmployeeDTO>
    <AddressLine1>sample string 17</AddressLine1>
    <AddressLine2>sample string 18</AddressLine2>
    <BaseRate>15</BaseRate>
    <BenefitSeniorityDate 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>
    </BenefitSeniorityDate>
    <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>
    <City>sample string 19</City>
    <CompanyName>sample string 1</CompanyName>
    <CostCenters>
      <IncomeVerificationCostCenterDTO>
        <CostCenterDescription>sample string 2</CostCenterDescription>
        <Level>1</Level>
      </IncomeVerificationCostCenterDTO>
      <IncomeVerificationCostCenterDTO>
        <CostCenterDescription>sample string 2</CostCenterDescription>
        <Level>1</Level>
      </IncomeVerificationCostCenterDTO>
    </CostCenters>
    <Country>sample string 23</Country>
    <County>sample string 22</County>
    <DateOfBirth 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>
    </DateOfBirth>
    <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>
    <Email>sample string 27</Email>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusCode>sample string 8</EmployeeStatusCode>
    <EmployeeStatusDescription>sample string 9</EmployeeStatusDescription>
    <FirstName>sample string 5</FirstName>
    <FullOrPartTime>FullTime</FullOrPartTime>
    <Gender>Male</Gender>
    <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 25</HomePhone>
    <IsPrimary>true</IsPrimary>
    <JobCode>sample string 12</JobCode>
    <JobDescription>sample string 13</JobDescription>
    <JobTitle>sample string 14</JobTitle>
    <LastName>sample string 4</LastName>
    <LocationCode>sample string 29</LocationCode>
    <LocationDescription>sample string 30</LocationDescription>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 26</MobilePhone>
    <NotEligibleForRehire>true</NotEligibleForRehire>
    <OriginalHireDate 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>
    </OriginalHireDate>
    <PayFrequency>sample string 16</PayFrequency>
    <PayGroup>sample string 11</PayGroup>
    <PayType>Salary</PayType>
    <PersonalId>3</PersonalId>
    <PositionCode>sample string 31</PositionCode>
    <RecordType>Employee</RecordType>
    <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 7</SSN>
    <StandardHours>1</StandardHours>
    <State>sample string 20</State>
    <TaxType>W2</TaxType>
    <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>
    <TerminationReason>sample string 10</TerminationReason>
    <WorkPhone>sample string 24</WorkPhone>
    <ZipCode>sample string 21</ZipCode>
  </IncomeVerificationEmployeeDTO>
  <IncomeVerificationEmployeeDTO>
    <AddressLine1>sample string 17</AddressLine1>
    <AddressLine2>sample string 18</AddressLine2>
    <BaseRate>15</BaseRate>
    <BenefitSeniorityDate 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>
    </BenefitSeniorityDate>
    <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>
    <City>sample string 19</City>
    <CompanyName>sample string 1</CompanyName>
    <CostCenters>
      <IncomeVerificationCostCenterDTO>
        <CostCenterDescription>sample string 2</CostCenterDescription>
        <Level>1</Level>
      </IncomeVerificationCostCenterDTO>
      <IncomeVerificationCostCenterDTO>
        <CostCenterDescription>sample string 2</CostCenterDescription>
        <Level>1</Level>
      </IncomeVerificationCostCenterDTO>
    </CostCenters>
    <Country>sample string 23</Country>
    <County>sample string 22</County>
    <DateOfBirth 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>
    </DateOfBirth>
    <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>
    <Email>sample string 27</Email>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusCode>sample string 8</EmployeeStatusCode>
    <EmployeeStatusDescription>sample string 9</EmployeeStatusDescription>
    <FirstName>sample string 5</FirstName>
    <FullOrPartTime>FullTime</FullOrPartTime>
    <Gender>Male</Gender>
    <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 25</HomePhone>
    <IsPrimary>true</IsPrimary>
    <JobCode>sample string 12</JobCode>
    <JobDescription>sample string 13</JobDescription>
    <JobTitle>sample string 14</JobTitle>
    <LastName>sample string 4</LastName>
    <LocationCode>sample string 29</LocationCode>
    <LocationDescription>sample string 30</LocationDescription>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 26</MobilePhone>
    <NotEligibleForRehire>true</NotEligibleForRehire>
    <OriginalHireDate 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>
    </OriginalHireDate>
    <PayFrequency>sample string 16</PayFrequency>
    <PayGroup>sample string 11</PayGroup>
    <PayType>Salary</PayType>
    <PersonalId>3</PersonalId>
    <PositionCode>sample string 31</PositionCode>
    <RecordType>Employee</RecordType>
    <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 7</SSN>
    <StandardHours>1</StandardHours>
    <State>sample string 20</State>
    <TaxType>W2</TaxType>
    <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>
    <TerminationReason>sample string 10</TerminationReason>
    <WorkPhone>sample string 24</WorkPhone>
    <ZipCode>sample string 21</ZipCode>
  </IncomeVerificationEmployeeDTO>
</ArrayOfIncomeVerificationEmployeeDTO>