The Employee Object

Object Property Required Object Type Description Max Character Length
FirstName Yes String First Name Of Employee 150
LastName Yes String Last Name Of Employee 150
EMailAddress Yes String Email Address Of Employee 100
AccountEmployeeId No Integer Unique Id Of Employee 10
MiddleName No String Middle name Of Employee 40
AccountDepartmentId No Integer Department Id Of Employee 10
AccountRoleId No Integer Role Id Of Employee 10
AddressLine1 No String Address Line 1 Of Employee 300
AddressLine2 No String Address Line 2 Of Employee 300
City No String City Of Employee 100
Zip No String Zip Of Employee 50
CountryId No Integer CountryId Of Employee 3
HomePhoneNo No String Home Phone No Of Employee 40
WorkPhoneNo No String Work Phone No Of Employee 100
MobilePhoneNo No String Mobile Phone No Of Employee 100
TerminationDate No DateTime Termination Date Of Employee 19
IsDisabled No Boolean Disabled Status Of Employee 1
TimeZoneId No Integer TimeZone Id Of Employee 3
Prefix No String Prefix Of Employee 50
AccountLocationId No Integer Location Id Of Employee 10
Notes No String Notes Of Employee 1000
BillingTypeId No Integer Billing Type Id Of Employee 10
State No String State Of Employee 40
AllowedAccessFromIP No String Allowed Access From IP Of Employee 40
AccountBillingRateId No Integer Billing Rate Id Of Employee 10
EmployeeCode No String Employee Code Of Employee 100
EmployeeManagerId No Integer Employee Manager Id Of Employee 10
JobTitle No String Job Title Of Employee 200
EmployeePayTypeId No GUID Employee Pay Type Id Of Employee 36
HiredDate No DateTime Hired Date Of Employee 19
StatusId No Integer Status Id Of Employee 10
AccountWorkingDayTypeId No GUID Working Day Type Id Of Employee 36
AccountTimeOffPolicyId No GUID TimeOff Policy Id Of Employee 36
TimeOffApprovalTypeId No Integer TimeOff Approval Type Id Of Employee 10
AccountHolidayTypeId No GUID Holiday Type Id Of Employee 36
IsForcePasswordChange No Boolean Force Password Change Status Of Employee 1
CustomField1 No String CustomField 1 Of Employee 2000
CustomField2 No String CustomField 2 Of Employee 2000
CustomField3 No String CustomField 3 Of Employee 2000
CustomField4 No String CustomField 4 Of Employee 2000
CustomField5 No String CustomField 5 Of Employee 2000
CustomField6 No String CustomField 6 Of Employee 2000
CustomField7 No String CustomField 7 Of Employee 2000
CustomField8 No String CustomField 8 Of Employee 2000
CustomField9 No String CustomField 9 Of Employee 2000
CustomField10 No String CustomField 10 Of Employee 2000
CustomField11 No String CustomField 11 Of Employee 2000
CustomField12 No String CustomField 12 Of Employee 2000
CustomField13 No String CustomField 13 Of Employee 2000
CustomField14 No String CustomField 14 Of Employee 2000
CustomField15 No String CustomField 15 Of Employee 2000
UserInterfaceLanguage No String User Interface Language Of Employee 50
IsShowEmployeeProfilePicture No Boolean Show Employee Profile Picture Status Of Employee 1
IsTimeInOutAvailable No Boolean Time In Time Out Available Of Employee 1
BillingRate No Decimal Billing Rate Of Employee 10
EmployeeRate No Decimal Employee Rate Of Employee 10
StartDate No DateTime Start Date of Billing Of Employee 19
EndDate No DateTime End Date of Billing Of Employee 19
AccountWorkTypeId No Integer Work Type Id Of Employee 10
BillingRateCurrencyId No Integer Currency Id Of Billing Rate Of Employee 10
EmployeeRateCurrencyId No Integer Currency Id Of Employee Rate Of Employee 10

List All Employees

Returns a list of your all Employees in your TimeLive account.

GET /API/Employees

Example Request

curl "https://demo.livetecs.com/api/employees" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@livetecs.com",
    "EMailAddress": "bobbingham@livetecs.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Retrieve an Employee

Retrieves the Employee with the given ID. Returns a Employee object and a 200 OK response code if a valid identifier was provided.

GET /API/Employees/{EMPLOYEE_ID}

Example Request

curl "https://demo.livetecs.com/api/Employees/00001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@livetecs.com",
    "EMailAddress": "bobbingham@livetecs.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Retrieve an Employee by Employee Code

Retrieves the Employee with the given Code. Returns a Employee object and a 200 OK response code if a valid identifier was provided.

GET /API/Employees/GetEmployeeByEmployeeCode/{Employee_Code}

Example Request

curl "https://demo.livetecs.com/api/Employees/GetEmployeeByEmployeeCode/001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@livetecs.com",
    "EMailAddress": "bobbingham@livetecs.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Create an Employee

Creates an Employee in your TimeLive account and returns the Response Message.

POST /API/Employees
Object Property Required Object Type Description Max Character Length
FirstName Yes String First name of the newly created employee 150
LastName Yes String Last name of the newly created employee 150
EmailAddress Yes String Email of the newly created employee 100

Example Request

curl "https://demo.livetecs.com/api/employees" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'EmailAddress':'someone@example.com','FirstName':'john','LastName':'Doe'}"

Example Response

[			
    {			
        "id": "00001",			
        "message": "Employee Added Successfully"			
    }			
]

Update an Employee

Update an Employee in your TimeLive account and returns the Response Message.

POST /API/Employees/{EMPLOYEE_ID}

Example Request

curl "https://demo.livetecs.com/api/employees/00003" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'LastName':'Smith'}"

Example Response

[			
    {			
        "id": "00003",			
        "message": "Employee Updated Successfully"			
    }			
]

Delete an Employee

Delete an Employee. Returns a 200 OK response code if the call succeeded.

DELETE /API/Employee/{EMPLOYEE_ID}

Example Request

curl "https://demo.livetecs.com/api/employees/00003" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X DELETE \
      -H "Content-Type: application/json"

Example Response

[
    {
        "id": "00003",
        "message": "Employee Deleted Successfully"
    }
]