Employee Record
GET {{base_url}}/employee/:employeekey
Use this endpoint to retrieve a single employee from the Employees hub.
Response
| Field Name | Description |
|---|---|
| Employee | Unique identifier for the employee record |
| PIMID | Unique identifier from the project information management PIM integration in Vantagepoint. Internal use only. |
| EmployeeCompany | Company that the employee is associated with |
| Org | Client defined value that defines the organization up to 5 sublevels. Each level is two characters and are each separated by a user-defined delimiter. Sample valid values SF:AR:00:TS, BO:EN, CO:00, DC:AD. |
| Supervisor | Unique identifier for the supervisor |
| SupervisorName | First name, last name, and professional credentials (when available) of the supervisor |
| HireDate | Date of hire |
| Status | Status of the employee. Afor Active. Ifor Inactive. Tfor Terminated. Default: A. Sample valid values A, I, Tfrom CodeTable: CFGEmployeeStatus. |
| YearsOtherFirms | Number of years that the employee worked for other firms |
| PriorYearsFirm | Number of years that the employee previously worked for your firm if the employee worked for your firm, then left, and was rehired. This value is the previous number of years the employee worked for your firm prior to the hire date. |
| ReadyForProcessing | Yindicates that the record is approved for use in transaction processing. Nthe record is not ready. |
| PayOvtPct | Percentage of overtime the employee worked recorded for payroll |
| PaySpecialOvtpct | Special overtime percentage recorded for payroll |
| PayType | Pay type for the employee on payroll. Valid values: H: Hourly, S: Salary. |
| OtherPay | First one-time pay amount that is added to the gross and net pay amounts on a pay check |
| OtherPay2 | Second one-time pay amount that is added to the gross and net pay amounts on a pay check |
| OtherPay3 | Third one-time pay amount that is added to the gross and net pay amounts on a pay check |
| OtherPay4 | Fourth one-time pay amount that is added to the gross and net pay amounts on a pay check |
| OtherPay5 | Fifth one-time pay amount that is added to the gross and net pay amounts on a pay check |
| UseTotalHrsAsStd | Flag that indicates whether to use the total hours worked by this employee as the standard for Time Analysis reporting. Yindicates to use the total hours as standard on Time Analysis. Nindicates not to use the total hours as standard on Time Analysis. |
| ChangeDefaultLC | Flag that indicates whether or not the employee can change the default labor code in Time. Yindicates that an employee can change the labor code in timesheets. Nindicates an employee cannot modify the labor code in timesheets. |
| Locale | Default payroll tax locale |
| LocaleMethod | Tax locale method. Valid values: 0None, 1Follow the project locale, 2Percentage of wages. |
| IncludeLocalJurisOnly | Flag indicating whether or not the Only Include Local Jurisdictionsoption, located above the Locale area of the Payroll tab from the Employee Hub, is selected. Yindicates to only include local jurisdictions. Nindicates not to include just local jurisdictions. |
| AllowChargeUnits | Flag indicating whether the option Allow Employee to charge Units in Timesheetis selected. Yindicates that the employee can charge units in timesheets. Nindicates that the employee cannot charge units in timesheets. |
| RequireStartEndTime | Flag indicating whether the option Require Employee to enter Start and End Timesis selected in the Employees Hub |
| AllowBreakTime | Flag indicating whether the option Allow Employee to enter Meals and Breaksis selected in the Employees Hub |
| DefaultBreakStartDateTime | Value in Default Meal Start Time |
| DefaultBreakEndDateTime | Value in Default Meal End Time |
| OccupationalCode | The occupational code for Alaska entered on the Payroll tab of the Employee Hub for an employee |
| GeographicCode | The geographical code for Alaska entered on the Payroll tab of the Employee Hub for an employee who completes electronic filing in Alaska |
| StatutoryEmployee | Flag that indicates whether or not the Statutory Employeebox is selected from Form W-2 Information Box 13 of the Payroll tab in the Employee Hub for an employee |
| RetirementPlan | Flag that indicates whether or not the Retirement Plancheckbox is selected from the Form W-2 Information Box 13 Payroll tab in the Employee Hub for an employee |
| ThirdPartySickPay | Flag that indicates whether or not the Third Party Sick Paycheckbox is selected from the Form W-2 Information Box 13 Payroll tab in the Employee Hub for an employee |
| ClieOp | Flag that indicates whether or not the ClieOP format is used |
| HomeCompany | The employee's home office expressed as a two character company code |
| Salutation | Prefix to a person's name from CodeTable: CFGPrefix |
| FirstName | First or chosen name |
| MiddleName | Middle name |
| LastName | Family or given name(s) |
| Suffix | Suffix appended to a name from CodeTable: CFGSuffix |
| PreferredName | Name the person prefers to be called, usually a first name, which may differ from the full name provided |
| Title | Person's professional title typically given to them by the organization to which they belong |
| Email address | |
| WorkPhone | Work phone number |
| WorkPhoneExt | Extension for the work phone number |
| MobilePhone | Mobile or cellular phone number |
| AvailableForCRM | Yindicates that the record is available to CRM users. Nindicates that the record is not available to CRM users. |
| ReadyForApproval | Yindicates that the record is available for approval by accounting users. Nindicates that the record is not ready for approval. |
| Address1 | Line 1 of the address |
| Address2 | Line 2 of the address |
| Address3 | Line 3 of the address |
| City | Name of the City |
| State | Name of the state or province |
| Zip | Postal zip code |
| Country | Name of the country |
| Memo | Notes about the object |
| Fax | Fax number |
| UtilizationRatio | Maximum amount of time (expressed as a percentage) that you can assign the employee as a named resource on your firm's projects. Resource managers can use the utilization target to help determine if an employee is overutilized or underutilized. |
| TargetRatio | Percentage of the employee's hours anticipated will be charged to a project |
| WorkPhoneFormat | Format of the work telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| MobilePhoneFormat | Format of the mobile telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| FaxFormat | Format of the fax telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| Language | Specify the language based on ISO language codes to set localisation. See employee metadata for valid codes. |
| ConsultantInd | Flag Y/N" that indicates whether or not the employee is a consultant |
| ClientVendorInd | Flag C/ Vindicating whether or not the client/vendor option is selected |
| Vendor | Consultant or partner name |
| ClientID | Unique identifier for the client record |
| ClendorName | Name of the firm |
| HasPhoto | 0 or 1. 0 - The object does not have a photo. 1 - The object does have a photo. |
| PhotoModDate | Date and timestamp of when the contact photo was updated |
| CreateUser | Name of the person who created the new record |
| CreateDate | Date and timestamp when the new record was created |
| ModUser | Name of the person who modified an existing record of this type |
| ModDate | Date and timestamp when the existing record of this type was modified |
| TalentUserID | Unique identifier for the talent management user |
| QBOID | Identifier of the Quickbooks client or vendor |
| QBOAddressID | Identifier of the Quickbooks address |
| QBOLastUpdated | Date and time the Quickbooks transaction was last changed |
| QBOVendorID | Identifier of the connected Quickbooks vendor |
| HoursPerDay | Number of hours per day that the employee works |
| RaiseDate | When the employee received an increase in pay |
| TerminationDate | Date that the employee was terminated |
| TaxRegistrationNumber | Tax registration number |
| HomePhone | Home telephone number |
| HomePhoneFormat | Format of the home telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| SSN | Social security number |
| JobCostRate | Employee's job cost rate |
| JCOvtPct | Overtime percentage |
| JCSpecialOvtPct | Employee's job cost special overtime percentage |
| JobCostType | Job cost type. See valid codes in metadata. Sample valid values: Hand S. |
| ProvCostRate | Provisional cost rate for unposted time on an interactive project report |
| ProvCostOTPct | Provisional cost rate for unposted overtime on interactive project reports |
| ProvCostSpecialOTPct | Employee's provisional cost percentage for unposted special overtime in interactive project reports |
| ProvBillRate | Provisional billing rate for unposted time on an interactive project report |
| ProvBillOTPct | Provisional billing rate for unposted overtime on interactive project reports |
| ProvBillSpecialOTPct | Employee's provisional billing percentage for unposted special overtime in interactive project reports |
| Type | Employee type. Valid values are PPrincipal, EEmployee, and MManagement. |
| BillingCategory | Default billing category to when the labor billing method is By Category |
| BillingCategoryCode | Labor category code |
| ADPFileNumber | ADP file number found on the employee's pay stub that identifies the employee's ADP files |
| ADPCompanyCode | ADP company code found on the employee's pay stub. This code associates the employee with your company when you use ADP. |
| ADPRateCode | ADP rate code which dictates an employee pay rate |
| PaychexCode1 | Paychex code for your company to represent regular hours |
| PaychexCode2 | Paychex code for your company to represent overtime hours |
| PaychexCode3 | Paychex code for your company to represent secondary overtime hours |
| PaychexRateNumber | Denote salary versus hourly employees with a dynamic rate number that is a numeric value 1-5 or M to mark the hours as memohours. Memo hours are consumed hours that are not considered pay hours. |
| EmailPayrollRemittance | Indicates whether or not email payroll remittance is selected |
| EmailExpenseRemittance | Indicates whether or not email expense remittance is selected |
| ClieOpAccount | Account number using the ClieOp format |
| ClieOpAccountType | The type of Clieop account type (checking or savings). See metadata for valid codes. |
| ClieOpTransactionType | ClieOp transaction type |
| SEPAIBAN | The international bank account number for your company to identify which organization is distributing payments |
| SEPABIC< | Bank identification code for your company |
| TKGroup | Time group category |
| CheckHours | Variable indicating whether or not hours on timesheets submitted are checked against the expected number of hours. See metadata for valid codes. |
| DefaultLC1 | Level 1 default labor code for timesheets |
| DefaultLC2 | Level 2 default labor code for timesheets |
| DefaultLC3 | Level 3 default labor code for timesheets |
| DefaultLC4 | Level 4 default labor code for timesheets |
| DefaultLC5 | Level 5 default labor code for timesheets |
| EKGroup | Employee's expense reporting group |
| CostRateMeth | Cost method. See employee metadata for valid codes. |
| CostRateTableNo | Cost table |
| PayRateMeth | Pay rate method. See employee metadata for valid codes. |
| PayRateTableNo< | Pay table |
| DisableTSRevAudit | Flag that indicates whether or not to disable the timesheet revision auditing |
| TKAdminLevel | Time administration level for the employee. See employee metadata for valid codes. |
| TKAdminEdit | Variable indicating whether the employee can edit the timesheets of other users in the same time group |
| EKAdminLevel | Expense administration level for the employee. See employee metadata for valid codes. |
| EKAdminEdit | Variable indicating whether or not the employee can edit the expense reports of other employees in the same expense group |
| ProfessionalSuffix | Professional credential appended to a name usually as an acronym |
| TaxRegistrationCountry | Country the financial company has a registered tax number. Valid values from CodeTable: FW_CFGCountry. |
| ADA | Flag Y/N" that indicates ADA status |
| BirthDate | Date of birth |
| Gender | Employee's gender. Valid values: 0Male, 1Female, 2Unknown. |
| MaritalStatus | Flag indicating the employee's marital status. Valid values: 0Unmarried ,1 Married,2 Divorced,3 Separated,4 Widowed,5" Unknown. |
| Ethnicity | Employee's ethnicity. Valid values from CodeTable: CFGRace. |
| VisaType | Type of visa. Valid values from CodeTable: CFGCitizenship. |
| VisaCountry | Country that issued the visa. Valid values from CodeTable: FW_CFGCountry. |
| VisaNumber | Numeric identifier of the visa |
| VisaExpDate | Date when the visa expires |
| Disabled | Flag that indicates whether or not the employee has a disability status |
| AlienNumber | Unique alien registration number for non-citizens issued for the purpose of employment authorization |
| PassportCountry | Country that issued the passport. Valid values from CodeTable: FW_CFGCountry. |
| PassportNumber | Unique number assigned to the passport upon issue |
| PassportExpDate | Date when the passport expires |
| CitizenshipStatus | Citizenship status |
| I9Verification | Indicates the status of Form I-9 eligibility verification for work authorization |
| MailAddress1 | Line 1 of the mailing address |
| MailAddress2 | Line 2 of the mailing address |
| MailAddress3 | Line 3 of the mailing address |
| MailCity | City for the mailing address |
| MailState | State for the mailing address. Valid values from CodeTable: cfgStates. |
| MailZIP | Postal zip code for the mailing address |
| MailCountry | Country for the mailing address. Valid values from CodeTable: FW_CFGCountry. |
| MailAddressSameAsHome | Flag that indicates whether or not the mailing address is the same address as the home address |
| HomeEMail | Personal email |
| PrimaryContact | Primary contact |
| PrimaryContactPhone | Phone number for the primary contact |
| PrimaryContactPhoneFormat | Format of the primary contact's telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| PrimaryContactRelationship | Relationship type with the primary contact. Valid values from CodeTable: CFGHRRelationship. |
| SecondaryContact | Secondary contact |
| SecondaryContactPhone | Phone number for the secondary contact |
| SecondaryContactPhoneFormat | Format of the secondary contact's telephone number set by admin under Settings » Labels and Lists » Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: (###) ###-###or ###.###.####. |
| SecondaryContactRelationship | Relationship type with the secondary contact. Valid values from CodeTable: CFGHRRelationship. |
| VetStatus | Flag indicating whether or not the employee is a military veteran |
| VetType | Type of veteran. Valid values from CodeTable: CFGVeteran. |
| SeparationDate | Date when the employee and the organization officially conducted the separation when the employment agreement ended |
| Class | Employee class. Valid values from CodeTable: CFGBPEmployeeClass. |
| JobLevel | An organization's system of assigning job aspects to each level of work as it relates to the employee's job title and function. Valid values from CodeTable: CFGJobLevel. |
| JobLevelDescription | Description of the job level |
| SOCCodeDescription | Description of the SOC code |
| FLSAStatus | Employee status of whether or not they are exempt from overtime according to the Fair Labor Standards Act. See employee metadata for valid codes. |
| SOCCode | Code from the Standard Occupational Classification System according to the U.S. federal government used by agencies to collect data. Valid values from CodeTable: CFGSOCCode. |
| WorkSchedule | Employee's work schedule, for example, full-time, part-time, or temporary. See emmployee metadata for valid codes. |
| RehireDate | Date of rehire |
| SeniorityDate | Date of employment seniority |
| TerminationReason | Description of why the employee was terminated |
| TerminationType | Types of employee termination. See valid codes in metadata. Example: Voluntary, Involuntary, Retired. |
| LastDayWorked | Last day the employee worked |
| LastDayPaid | Last day of employee pay |
| ExitInterviewer | Identifier of the employee who conducted the exit interview |
| RehireEligible | Flag that indicates whether or not the employee can be rehired |
| UIPaymentMethod | Payment method on the user interface. Default: N. |
| PayrollFrequency | Variable indicating the payroll frequency: M- Monthly. S- Semi-Monthly. B- Bi-Weekly. W- Weekly. |
| TotalYearsWithThisFirm | Sum of the number of years of experience the employee has with this firm |
| TotalYearsExperience | Sum of the number of years of experience |
| HomeCompanyName | Name of the company with home designation |
| EmployeeCompanyName | Name of the company associated with the employee |
| OrganizationName | Name of the organization |
| TitleName | Full employee name with professional title |
| Location | Where the employee is located or works from. Valid values from CodeTable: CFGEMLocation. |
| LocationDescription | Description of the location where the employee works |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
[{"Employee":"00010","PIMID":"InternalUseOnlyGUID","EmployeeCompany":"PR","Org":"PR:00:SF:EN","Supervisor":"01416","SupervisorName":"Peter O'Leary","HireDate":"1982-05-17T00:00:00.000","Status":"A","YearsOtherFirms":5,"PriorYearsFirm":0,"ReadyForProcessing":"Y","PayRate":2165,"PayOvtPct":0,"PaySpecialOvtPct":0,"PayType":"S","OtherPay":0,"OtherPay2":0,"OtherPay3":0,"OtherPay4":0,"OtherPay5":0,"UseTotalHrsAsStd":"N","ChangeDefaultLC":"Y","Locale":"MA","LocaleMethod":"1","IncludeLocalJurisOnly":"N","AllowChargeUnits":"N","RequireStartEndTime":"N","AllowBreakTime":"N","DefaultBreakStartDateTime":"","DefaultBreakEndDateTime":"","OccupationalCode":"","GeographicCode":"","StatutoryEmployee":"N","RetirementPlan":"N","ThirdPartySickPay":"N","ClieOp":"N","HomeCompany":"PR","Salutation":"Ms.","FirstName":"Lisa","MiddleName":"May","LastName":"Evans","Suffix":"","PreferredName":"","Title":"CADD Operator","EMail":"lmevans@applebartlett.com","WorkPhone":"415","WorkPhoneExt":"204","MobilePhone":"415.678.0289","AvailableForCRM":"Y","ReadyForApproval":"Y","Address1":"55 Candleberry Lane","Address2":"","Address3":"","City":"Harvard","State":"MA","ZIP":"01478-6107","Country":"","Memo":"","FAX":"415.644.8702","UtilizationRatio":70,"TargetRatio":70,"WorkPhoneFormat":"","MobilePhoneFormat":"","FaxFormat":"","Language":"en-US","ConsultantInd":"N","ClientVendorInd":"V","Vendor":"","ClientID":"","ClendorName":"","HasPhoto":0,"PhotoModDate":"","CreateUser":"Brenda Gray, PE","CreateDate":"2007-01-14T21:52:31.573","ModUser":"Steve Anderson, AIA","ModDate":"2007-06-12T21:33:08.000","TalentUserID":"","QBOID":"","QBOAddressID":"","QBOLastUpdated":"","QBOVendorID":"","HoursPerDay":8,"RaiseDate":"1997-01-01T00:00:00.000","TerminationDate":"","TaxRegistrationNumber":"","HomePhone":"","HomePhoneFormat":"","SSN":"015-55-4555","JobCostRate":27,"JCOvtPct":100,"JCSpecialOvtPct":0,"JobCostType":"H","ProvCostRate":27,"ProvCostOTPct":100,"ProvCostSpecialOTPct":0,"ProvBillRate":81,"ProvBillOTPct":100,"ProvBillSpecialOTPct":0,"Type":"E","BillingCategory":7,"BillingCategoryCode":"7","ADPFileNumber":"00010","ADPCompanyCode":"","ADPRateCode":"","PaychexCode1":"","PaychexCode2":"","PaychexCode3":"","PaychexRateNumber":"","EmailPayrollRemittance":"N","EmailExpenseRemittance":"N","ClieOpAccount":"","ClieOpAccountType":"","ClieOpTransactionType":"","SEPAIBAN":"","SEPABIC":"","TKGroup":"ST","CheckHours":"","DefaultLC1":"","DefaultLC2":"","DefaultLC3":"","DefaultLC4":"","EKGroup":"","CostRateMeth":0,"CostRateTableNo":0,"PayRateMeth":0,"PayRateTableNo":0,"DisableTSRevAudit":"N","TKAdminLevel":"0","TKAdminEdit":"N","EKAdminLevel":"0","EKAdminEdit":"N","ProfessionalSuffix":"","TaxRegistrationCountry":"","ADA":"N","BirthDate":"","Gender":"","MaritalStatus":"","Ethnicity":"","VisaType":"","VisaCountry":"","VisaNumber":"","VisaExpDate":"","Disabled":"N","AlienNumber":"","PassportCountry":"","PassportNumber":"","PassportExpDate":"","CitizenshipStatus":"","I9Verification":"","MailAddress1":"","MailAddress2":"","MailAddress3":"","MailCity":"","MailState":"","MailZIP":"","MailCountry":"","MailAddressSameAsHome":"N","HomeEMail":"","PrimaryContact":"","PrimaryContactPhone":"","PrimaryContactPhoneFormat":"","PrimaryContactRelationship":"","SecondaryContact":"","SecondaryContactPhone":"","SecondaryContactPhoneFormat":"","SecondaryContactRelationship":"","VetStatus":"N","VetType":"","SeparationDate":"","Class":"","JobLevel":"","JobLevelDescription":"","SOCCodeDescription":"","FLSAStatus":"","SOCCode":"","WorkSchedule":"","RehireDate":"","SeniorityDate":"","TerminationReason":"","TerminationType":"","LastDayWorked":"","LastDayPaid":"","ExitInterviewer":"","RehireEligible":"","UIPaymentMethod":"","PayrollFrequency":"S","TotalYearsWithThisFirm":36,"TotalYearsExperience":41,"HomeCompanyName":"Apple \u0026 Bartlett, PC (EQ auto numbers)","EmployeeCompanyName":"Apple \u0026 Bartlett, PC (EQ auto numbers)","OrganizationName":"San Fran Engineering","TitleName":"Lisa Evans","Location":"","LocationDescription":"","Custbird":"","CustProjectfield":"","desc_CustProjectfield":"","CustcustomfieldaddedtotheProfessionaltab":"","CustLayoutfield":"","desc_CustLayoutfield":"","Custdatefield":"","CustAccountfield":"","desc_CustAccountfield":"","CustEmployeefield":"","desc_CustEmployeefield":"","CustCurrencyRecordfield":0,"CustCurrencySpecificfield":0,"CustNumeric2field":0,"CustDropdownfield":"","CustCharacterfield":""}]