GET v1/supplemental-benefits/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}?asOf={asOf}
Retrieve Supplemental Benefits Employee by Division
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
The company code. |
string |
Required |
| divisionCode |
The division code. |
string |
Required |
| employeeNumber |
The employee number. |
string |
Required |
| asOf | date |
None. |
Body Parameters
None.
Response Information
Resource Description
SupplementalBenefitsEmployeeDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyCode | string |
None. |
|
| DivisionCode | string |
None. |
|
| EmployeeNumber | string |
None. |
|
| EmployeeKey | GlobalEntityKeyOfIEmployee |
None. |
|
| LastName | string |
None. |
|
| FirstName | string |
None. |
|
| MiddleInitial | character |
None. |
|
| Gender | Gender |
None. |
|
| BirthDate | date |
None. |
|
| EmployeeStatus | EmployeeStatus |
None. |
|
| EmployeeType | FullOrPartTime |
None. |
|
| EmploymentStatusEffectiveDate | date |
None. |
|
| OriginalHireDate | date |
None. |
|
| HireDate | date |
None. |
|
| RehireDate | date |
None. |
|
| TerminationDate | date |
None. |
|
| LastCheckDate | date |
None. |
|
| LastCheckPeriodEnd | date |
None. |
|
| LastCheckGrossAmount | decimal number |
None. |
|
| LastCheckNetAmount | decimal number |
None. |
|
| PayType | PayType |
None. |
|
| TaxType | EETaxType |
None. |
|
| PayFrequency | PayFrequency |
None. |
|
| AnnualSalary | decimal number |
None. |
|
| WorkPhone | string |
None. |
|
| WorkExtension | string |
None. |
|
| HomePhone | string |
None. |
|
| MobilePhone | string |
None. |
|
| string |
None. |
||
| Address | AddressDTO |
None. |
|
| WorkState | string |
None. |
|
| PersonalId | EntityKeyOfIEmployeePersonalAndInt32 |
None. |
Response Formats
application/json, text/json
Sample:
{
"companyCode": "sample string 1",
"divisionCode": "sample string 2",
"employeeNumber": "sample string 3",
"employeeKey": "<empty>",
"lastName": "sample string 4",
"firstName": "sample string 5",
"middleInitial": "A",
"gender": "Male",
"birthDate": "0001-02-03",
"employeeStatus": "Active",
"employeeType": "FullTime",
"employmentStatusEffectiveDate": "0001-02-03",
"originalHireDate": "0001-02-03",
"hireDate": "0001-02-03",
"rehireDate": "0001-02-03",
"terminationDate": "0001-02-03",
"lastCheckDate": "0001-02-03",
"lastCheckPeriodEnd": "0001-02-03",
"lastCheckGrossAmount": 1.0,
"lastCheckNetAmount": 1.0,
"payType": "Salary",
"taxType": "W2",
"payFrequency": "YEAR",
"annualSalary": 1.0,
"workPhone": "sample string 7",
"workExtension": "sample string 8",
"homePhone": "sample string 9",
"mobilePhone": "sample string 10",
"email": "sample string 11",
"address": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"zip": "sample string 5",
"country": "sample string 6",
"county": "sample string 7"
},
"workState": "sample string 12",
"personalId": "<empty>"
}
text/xml
Sample:
<SupplementalBenefitsEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
<d2p1:Address1>sample string 1</d2p1:Address1>
<d2p1:Address2>sample string 2</d2p1:Address2>
<d2p1:City>sample string 3</d2p1:City>
<d2p1:Country>sample string 6</d2p1:Country>
<d2p1:County>sample string 7</d2p1:County>
<d2p1:State>sample string 4</d2p1:State>
<d2p1:Zip>sample string 5</d2p1:Zip>
</Address>
<AnnualSalary>1</AnnualSalary>
<BirthDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</BirthDate>
<CompanyCode>sample string 1</CompanyCode>
<DivisionCode>sample string 2</DivisionCode>
<Email>sample string 11</Email>
<EmployeeKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d2p1:_entityKey>
<d2p1:_hasValue>false</d2p1:_hasValue>
<d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
</d2p1:_entityKey>
</EmployeeKey>
<EmployeeNumber>sample string 3</EmployeeNumber>
<EmployeeStatus>Active</EmployeeStatus>
<EmployeeType>FullTime</EmployeeType>
<EmploymentStatusEffectiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</EmploymentStatusEffectiveDate>
<FirstName>sample string 5</FirstName>
<Gender>Male</Gender>
<HireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</HireDate>
<HomePhone>sample string 9</HomePhone>
<LastCheckDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</LastCheckDate>
<LastCheckGrossAmount>1</LastCheckGrossAmount>
<LastCheckNetAmount>1</LastCheckNetAmount>
<LastCheckPeriodEnd xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</LastCheckPeriodEnd>
<LastName>sample string 4</LastName>
<MiddleInitial>65</MiddleInitial>
<MobilePhone>sample string 10</MobilePhone>
<OriginalHireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</OriginalHireDate>
<PayFrequency>YEAR</PayFrequency>
<PayType>Salary</PayType>
<PersonalId xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d2p1:_hasValue>false</d2p1:_hasValue>
<d2p1:_value>0</d2p1:_value>
</PersonalId>
<RehireDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</RehireDate>
<TaxType>W2</TaxType>
<TerminationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
<d2p1:Year>1</d2p1:Year>
<d2p1:Month>2</d2p1:Month>
<d2p1:Day>3</d2p1:Day>
</TerminationDate>
<WorkExtension>sample string 8</WorkExtension>
<WorkPhone>sample string 7</WorkPhone>
<WorkState>sample string 12</WorkState>
</SupplementalBenefitsEmployeeDTO>