Create an Employee Record

POST {{base_url}}/employee

Use this endpoint to create a new employee in the Employees hub.

Specify the data for the new employee in the request body. Minimum required data include required fields and defaults from the employee metadata.

The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.

The supervisor must be an employee record that already exists. Obtain the existing record from

GET {{base_url}}/employee or GET {{base_url}}/employee/{{employeekey}}

Request

A successful call status of 201 Created returns the JSON representation for the newly created employee record.

Request Params

The flag that indicates whether or not the validation for required screen designer fields is needed.

Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.

NOTE: This does not apply to required system fields. | | startWorkflow | string | | Optional.

The flag that indicates whether or not the trigger for a workflow is initiated.

Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |

Request Body

[{"name"=>"Employee", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"PIMID", "value"=>"String", "datatype"=>"string"}, {"name"=>"EmployeeCompany", "value"=>"Company", "datatype"=>"string"}, {"name"=>"Org", "value"=>"Org", "datatype"=>"string"}, {"name"=>"Supervisor", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"HireDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"RehireDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"SeniorityDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"LastDayWorked", "value"=>"Date", "datatype"=>"string"}, {"name"=>"ExitInterviewer", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"RehireEligible", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"Status", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"YearsOtherFirms", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PriorYearsFirm", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ReadyForProcessing", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"PayRate", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PayOvtPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PaySpecialOvtPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PayType", "value"=>"String", "datatype"=>"string"}, {"name"=>"OtherPay", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"OtherPay2", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"OtherPay3", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"OtherPay4", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"OtherPay5", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"UseTotalHrsAsStd", "value"=>"String", "datatype"=>"string"}, {"name"=>"ChangeDefaultLC", "value"=>"String", "datatype"=>"string"}, {"name"=>"Locale", "value"=>"String", "datatype"=>"string"}, {"name"=>"LocaleMethod", "value"=>"String", "datatype"=>"string"}, {"name"=>"IncludeLocalJurisOnly", "value"=>"String", "datatype"=>"string"}, {"name"=>"AllowChargeUnits", "value"=>"String", "datatype"=>"string"}, {"name"=>"RequireStartEndTime", "value"=>"String", "datatype"=>"string"}, {"name"=>"AllowBreakTime", "value"=>"String", "datatype"=>"string"}, {"name"=>"DefaultBreakStartDateTime", "value"=>"Date", "datatype"=>"string"}, {"name"=>"DefaultBreakEndDateTime", "value"=>"Date", "datatype"=>"string"}, {"name"=>"OccupationalCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"GeographicCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"StatutoryEmployee", "value"=>"String", "datatype"=>"string"}, {"name"=>"RetirementPlan", "value"=>"String", "datatype"=>"string"}, {"name"=>"ThirdPartySickPay", "value"=>"String", "datatype"=>"string"}, {"name"=>"ClieOp", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomeCompany", "value"=>"Company", "datatype"=>"string"}, {"name"=>"Salutation", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"FirstName", "value"=>"String", "datatype"=>"string"}, {"name"=>"MiddleName", "value"=>"String", "datatype"=>"string"}, {"name"=>"LastName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Suffix", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PreferredName", "value"=>"String", "datatype"=>"string"}, {"name"=>"Title", "value"=>"String", "datatype"=>"string"}, {"name"=>"EMail", "value"=>"String", "datatype"=>"string"}, {"name"=>"WorkPhone", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"WorkPhoneExt", "value"=>"String", "datatype"=>"string"}, {"name"=>"MobilePhone", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"AvailableForCRM", "value"=>"String", "datatype"=>"string"}, {"name"=>"ReadyForApproval", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address1", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address2", "value"=>"String", "datatype"=>"string"}, {"name"=>"Address3", "value"=>"String", "datatype"=>"string"}, {"name"=>"City", "value"=>"String", "datatype"=>"string"}, {"name"=>"State", "value"=>"String", "datatype"=>"string"}, {"name"=>"ZIP", "value"=>"String", "datatype"=>"string"}, {"name"=>"Country", "value"=>"String", "datatype"=>"string"}, {"name"=>"Memo", "value"=>"String", "datatype"=>"string"}, {"name"=>"FAX", "value"=>"String", "datatype"=>"string"}, {"name"=>"UtilizationRatio", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"TargetRatio", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"WorkPhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"MobilePhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"FaxFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"ConsultantInd", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"ClientVendorInd", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Vendor", "value"=>"Vendor", "datatype"=>"string"}, {"name"=>"ClientID", "value"=>"String", "datatype"=>"string"}, {"name"=>"TalentUserID", "value"=>"String", "datatype"=>"string"}, {"name"=>"HoursPerDay", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"RaiseDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"TerminationDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"TerminationReason", "value"=>"String", "datatype"=>"string"}, {"name"=>"TerminationType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"TaxRegistrationNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomePhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomePhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"SSN", "value"=>"String", "datatype"=>"string"}, {"name"=>"JobCostRate", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"JCOvtPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"JCSpecialOvtPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"JobCostType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"ProvCostRate", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ProvCostOTPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ProvCostSpecialOTPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ProvBillRate", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ProvBillOTPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"ProvBillSpecialOTPct", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"Type", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Class", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"JobLevel", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"FLSAStatus", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"SOCCode", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"WorkSchedule", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"BillingCategory", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"BillingCategoryCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"ADPFileNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"ADPCompanyCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"ADPRateCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"PaychexCode1", "value"=>"String", "datatype"=>"string"}, {"name"=>"PaychexCode2", "value"=>"String", "datatype"=>"string"}, {"name"=>"PaychexCode3", "value"=>"String", "datatype"=>"string"}, {"name"=>"PaychexRateNumber", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"EmailPayrollRemittance", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"EmailExpenseRemittance", "value"=>"String", "datatype"=>"string"}, {"name"=>"ClieOpAccount", "value"=>"String", "datatype"=>"string"}, {"name"=>"ClieOpAccountType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"ClieOpTransactionType", "value"=>"String", "datatype"=>"string"}, {"name"=>"SEPAIBAN", "value"=>"String", "datatype"=>"string"}, {"name"=>"SEPABIC", "value"=>"String", "datatype"=>"string"}, {"name"=>"TKGroup", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CheckHours", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DefaultLC1", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DefaultLC2", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DefaultLC3", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DefaultLC4", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"EKGroup", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CostRateMeth", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CostRateTableNo", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PayRateMeth", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PayRateTableNo", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"DisableTSRevAudit", "value"=>"Checkbox", "datatype"=>"string"}, {"name"=>"TKAdminLevel", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"EKAdminLevel", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"TKAdminEdit", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"EKAdminEdit", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"ProfessionalSuffix", "value"=>"String", "datatype"=>"string"}, {"name"=>"Location", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"UIPaymentMethod", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"TaxRegistrationCountry", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"ADA", "value"=>"String", "datatype"=>"string"}, {"name"=>"BirthDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"Gender", "value"=>"String", "datatype"=>"string"}, {"name"=>"MaritalStatus", "value"=>"String", "datatype"=>"string"}, {"name"=>"Ethnicity", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"VisaType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"VisaCountry", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"VisaNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"VisaExpDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"Disabled", "value"=>"String", "datatype"=>"string"}, {"name"=>"AlienNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"PassportCountry", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"PassportNumber", "value"=>"String", "datatype"=>"string"}, {"name"=>"PassportExpDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"CitizenshipStatus", "value"=>"String", "datatype"=>"string"}, {"name"=>"I9Verification", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailAddress1", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailAddress2", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailAddress3", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailCity", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailState", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"MailZIP", "value"=>"String", "datatype"=>"string"}, {"name"=>"MailCountry", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"MailAddressSameAsHome", "value"=>"String", "datatype"=>"string"}, {"name"=>"HomeEMail", "value"=>"String", "datatype"=>"string"}, {"name"=>"PrimaryContact", "value"=>"String", "datatype"=>"string"}, {"name"=>"PrimaryContactPhone", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"PrimaryContactPhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"PrimaryContactRelationship", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"SecondaryContact", "value"=>"String", "datatype"=>"string"}, {"name"=>"SecondaryContactPhone", "value"=>"Phone", "datatype"=>"string"}, {"name"=>"SecondaryContactPhoneFormat", "value"=>"String", "datatype"=>"string"}, {"name"=>"SecondaryContactRelationship", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"VetStatus", "value"=>"String", "datatype"=>"string"}, {"name"=>"VetType", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"SeparationDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"Language", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"QBOID", "value"=>"String", "datatype"=>"string"}, {"name"=>"QBOAddressID", "value"=>"String", "datatype"=>"string"}, {"name"=>"QBOLastUpdated", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"QBOVendorID", "value"=>"Dropdown", "datatype"=>"string"}]

HEADERS

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: Created

[{"Employee":"00004","EmployeeCompany":"PR","Org":"PR:00:BO:AD","Supervisor":"","SupervisorName":"","HireDate":"","Status":"A","YearsOtherFirms":0,"PriorYearsFirm":0,"ReadyForProcessing":"Y","PayRate":0,"PayOvtPct":0,"PaySpecialOvtPct":0,"PayType":"H","OtherPay":0,"OtherPay2":0,"OtherPay3":0,"OtherPay4":0,"OtherPay5":0,"UseTotalHrsAsStd":"N","ChangeDefaultLC":"Y","Locale":"","LocaleMethod":"0","IncludeLocalJurisOnly":"N","AllowChargeUnits":"N","RequireStartEndTime":"N","AllowBreakTime":"N","DefaultBreakStartDateTime":"","DefaultBreakEndDateTime":"","OccupationalCode":"","GeographicCode":"","StatutoryEmployee":"N","FormW4Version":2020,"FormW4Step2":"N","FormW4Dependents":0,"FormW4DependentsOther":0,"FormW4OtherTaxCredit":0,"FormW4OtherIncome":0,"FormW4Deductions":0,"RetirementPlan":"N","ThirdPartySickPay":"N","ClieOp":"N","HomeCompany":"PR","Salutation":"","FirstName":"","MiddleName":"","LastName":"APItestln","Suffix":"","PreferredName":"","Title":"","EMail":"","WorkPhone":"","MobilePhone":"","AvailableForCRM":"Y","ReadyForApproval":"Y","Address1":"","Address2":"","Address3":"","City":"","State":"","ZIP":"","Country":"","Memo":"","FAX":"","UtilizationRatio":0,"TargetRatio":0,"WorkPhoneFormat":"","MobilePhoneFormat":"","FaxFormat":"","Language":"en-US","ConsultantInd":"N","ClientVendorInd":"C","Vendor":"","ClientID":"","ClendorName":"","HasPhoto":0,"PhotoModDate":"","CreateUser":"ADMIN","CreateDate":"2021-12-08T17:11:12.417","CreateUserName":"Annie Johnson","ModUser":"ADMIN","ModDate":"2021-12-08T17:11:12.417","ModUserName":"Annie Johnson","TalentUserID":"","QBOID":"","QBOAddressID":"","QBOLastUpdated":"","QBOVendorID":"","HoursPerDay":0,"RaiseDate":"","TerminationDate":"","TaxRegistrationNumber":"","HomePhone":"","HomePhoneFormat":"","SSN":"","JobCostRate":0,"JCOvtPct":0,"JCSpecialOvtPct":0,"JobCostType":"H","ProvCostRate":0,"ProvCostOTPct":0,"ProvCostSpecialOTPct":0,"ProvBillRate":0,"ProvBillOTPct":0,"ProvBillSpecialOTPct":0,"Type":"E","BillingCategory":0,"ADPFileNumber":"","ADPCompanyCode":"","ADPRateCode":"","PaychexCode1":"","PaychexCode2":"","PaychexCode3":"","PaychexRateNumber":"","EmailPayrollRemittance":"N","EmailExpenseRemittance":"N","ClieOpAccount":"","ClieOpAccountType":"","ClieOpTransactionType":"","SEPAIBAN":"","SEPABIC":"","TKGroup":"","CheckHours":"W","DefaultLC1":"0","DefaultLC2":"0","DefaultLC3":"00","DefaultLC4":"0","DefaultLC5":"","EKGroup":"","DefaultTaxLocation":"","CostRateMeth":0,"CostRateTableNo":0,"PayRateMeth":0,"PayRateTableNo":0,"DisableTSRevAudit":"N","TKAdminLevel":"","TKAdminEdit":"N","EKAdminLevel":"","EKAdminEdit":"N","ProfessionalSuffix":"","CitizenshipStatus":"","UIPaymentMethod":"N","PayrollFrequency":"S","TotalYearsWithThisFirm":0,"TotalYearsExperience":0,"HomeCompanyName":"Apple \u0026 Bartlett, PC (EQ auto numbers)","EmployeeCompanyName":"Apple \u0026 Bartlett, PC (EQ auto numbers)","TaxAuditingEnabled":"Y","OrganizationName":"Boston Admin","PIMID":"C8FD9B839115450BB2C3216D11F6897B","TitleName":"APItestln","Terminated":"N","Location":"","LocationDescription":"","CustNewField":"N","CustNewValueDropdown":"","desc_CustNewValueDropdown":"","Custbird":"","CustProjectfield":"","desc_CustProjectfield":"","CustcustomfieldaddedtotheProfessionaltab":"","CustLayoutfield":"","desc_CustLayoutfield":"","Custdatefield":"","CustAccountfield":"","desc_CustAccountfield":"","CustEmployeefield":"","desc_CustEmployeefield":"","CustCurrencyRecordfield":0,"CustCurrencySpecificfield":0,"CustNumeric2field":0,"CustDropdownfield":"","desc_CustDropdownfield":"","CustCharacterfield":"","CustDropdowntypefield2":"","desc_CustDropdowntypefield2":"","CustSeasonalEmploye":"N","CustSeasons":"","desc_CustSeasons":""}]