Create an Employee

POST /cloud/Data/V1/Employee

Creates an employee record in CompAnalyst.

URL

Method

POST

Request Headers

Authorization: Bearer {AccessToken}

Content-Type: application/json

Required Fields

“EmployeeId”
“CompanyJobCode”
“BaseSalary”

Important Behavior

Some of the fields on the employee record belong to separate tables in CompAnalyst and have pre-defined values. Please see the Reference section and Field Definitions > Employee for a full list.

For the purposes of this section, please note the employee must be linked to an existing CompanyJobCode in order to successfully be created.

If you are assigning the Employee to a specific Pay Market (TierCode), this Pay Market must also exist in the CompAnalyst account.

Glossary

Refer to Employees

Request Body

{
    "EmployeeID": "1232225",
    "DepartmentID": "Development",
    "FirstName": "Lin",
    "LastName": "Baba",
    "EmploymentStatusCode": "ES01",
    "CompanyJobCode": "PROD32",
    "ReportToEmployeeID": 2345,
    "Email": "Lindsay.Ford@shantaram.com",
    "BaseSalary": 100000.00,
    "Bonus": 8000.00,
    "IsExempt": true,
    "IsOTEligible": false,
    "AnnualWorkHours": 2080,
    "HireDate": "2022-09-01T00:00:00",
    "EmployeeCity": "Cambridge",
    "EmployeeStateCode": "MA",
    "EmployeeCountryCode": "USA",
    "EmployeeZipCode": "02139",
    "CurrencyCode": "USD",
    "IsActive": true,
    "PerformanceNum": 4.00,
    "TierCode": "New England",
    "BirthDate": "1985-02-15T00:00:00",
    "DateStartedJob": "2022-09-12T00:00:00",
    "GenderCode": "M",
    "EthnicityCode": "White",
    "IsSalaried": true,
    "PerfRatingScaleCode": "USA"
}

Response Model

200 OK

{
    "WEBAPIStatusCode": 0,
    "WEBAPIStatusDesc": "Success."
}