GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}?asOf={asOf}
Retrieve Employee by Employee Number
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
companyCode | string |
Required |
|
divisionCode | string |
Required |
|
employeeNumber | string |
Required |
|
asOf | date |
None. |
Body Parameters
None.
Response Information
Resource Description
TimeAttendanceEmployeeDTOName | Description | Type | Additional 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. |
|
EmployeeType | FullOrPartTime |
None. |
|
HireDate | date |
None. |
|
TerminationDate | date |
None. |
|
RehireDate | date |
None. |
|
PayGroup | string |
None. |
|
JobCode | string |
None. |
|
JobTitle | string |
None. |
|
BaseRate | decimal number |
None. |
|
PayType | PayType |
None. |
|
PayFrequency | PayFrequency |
None. |
|
StandardHours | decimal number |
None. |
|
AddressLine1 | string |
None. |
|
AddressLine2 | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
ZipCode | string |
None. |
|
ClockNumber | string |
None. |
|
DateOfBirth | date |
None. |
|
Gender | Gender |
None. |
|
WorkPhone | string |
None. |
|
WorkExtension | string |
None. |
|
HomePhone | string |
None. |
|
MobilePhone | string |
None. |
|
string |
None. |
||
Department | string |
None. |
|
LocationCode | string |
None. |
|
IsPrimary | boolean |
None. |
|
PersonalId | integer |
None. |
|
EmployeeRole | string |
None. |
|
UserRole | string |
None. |
|
IsSupervisor | boolean |
None. |
|
SupervisorKey | GlobalEntityKeyOfIEmployee |
None. |
|
ModifiedOn | date |
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", "employeeType": "FullTime", "hireDate": "0001-02-03", "terminationDate": "0001-02-03", "rehireDate": "0001-02-03", "payGroup": "sample string 6", "jobCode": "sample string 7", "jobTitle": "sample string 8", "baseRate": 9.0, "payType": "Salary", "payFrequency": "YEAR", "standardHours": 1.0, "addressLine1": "sample string 10", "addressLine2": "sample string 11", "city": "sample string 12", "state": "sample string 13", "zipCode": "sample string 14", "clockNumber": "sample string 15", "dateOfBirth": "0001-02-03", "gender": "Male", "workPhone": "sample string 16", "workExtension": "sample string 17", "homePhone": "sample string 18", "mobilePhone": "sample string 19", "email": "sample string 20", "department": "sample string 21", "locationCode": "sample string 22", "isPrimary": true, "personalId": 24, "employeeRole": "sample string 25", "userRole": "sample string 26", "isSupervisor": true, "supervisorKey": "<empty>", "modifiedOn": "2025-04-11T18:06:22.7603966Z" }
text/xml
Sample:
<TimeAttendanceEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models"> <AddressLine1>sample string 10</AddressLine1> <AddressLine2>sample string 11</AddressLine2> <BaseRate>9</BaseRate> <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> <City>sample string 12</City> <ClockNumber>sample string 15</ClockNumber> <DateOfBirth 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> </DateOfBirth> <Department>sample string 21</Department> <Email>sample string 20</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 1</EmployeeNumber> <EmployeeRole>sample string 25</EmployeeRole> <EmployeeStatus>Active</EmployeeStatus> <EmployeeType>FullTime</EmployeeType> <FirstName>sample string 3</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 18</HomePhone> <IsPrimary>true</IsPrimary> <IsSupervisor>true</IsSupervisor> <JobCode>sample string 7</JobCode> <JobTitle>sample string 8</JobTitle> <LastName>sample string 2</LastName> <LocationCode>sample string 22</LocationCode> <MiddleInitial>65</MiddleInitial> <MobilePhone>sample string 19</MobilePhone> <ModifiedOn>2025-04-11T14:06:22.7603966-04:00</ModifiedOn> <PayFrequency>YEAR</PayFrequency> <PayGroup>sample string 6</PayGroup> <PayType>Salary</PayType> <PersonalId>24</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> <SSN>sample string 5</SSN> <StandardHours>1</StandardHours> <State>sample string 13</State> <SupervisorKey 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> </SupervisorKey> <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> <UserRole>sample string 26</UserRole> <WorkExtension>sample string 17</WorkExtension> <WorkPhone>sample string 16</WorkPhone> <ZipCode>sample string 14</ZipCode> </TimeAttendanceEmployeeDTO>