☰
CompAnalyst
| API
×
Welcome to the Salary.com API Authentication
Data as a Service CompAnalyst and JobArchitect

DATA AS A SERVICE

Introduction & AI Market Data Job Match API
Behavior Request Field Definitions Response Field Definitions Match a Job POST Batch Match Jobs POST Match a Job (Verbose) POST Batch Match Jobs (Verbose) POST
Posting Data Job Match API
Behavior Request Field Definitions Response Field Definitions Match a Job POST Match a Job (Verbose) POST

COMPANALYST

Employees
Get an Employee GET Get Employee List GET Create an Employee POST Update an Employee PUT Delete an Employee DELETE
Company Jobs
Get a Company Job GET Get Company Job List GET Create a Company JobPOST Update a Company Job PUT
Composites
Get Composite ListGET Get Composite by Job CodeGET

JOBARCHITECT

Jobs
Get Job Description List GET Get a Job Description Details GET
Skills
Get Skills GET

REFERENCE

Field Definitions
Employees Company Jobs Salary Plan Competencies Composites JobArchitect Skills
Change Log

Employees

  • EmployeeID: int - Required field that provides a unique identification code of the employee.
  • EntityID: nvarchar(20) - Defines what CompAnalyst entity that the employee is classified under. Entities are used to define CompAnalyst user access, if employee data is to be deemed accessible only to certain users.
  • DepartmentID: nvarchar(200) - Field that specifies employee department identification (ID).
  • FirstName: nvarchar(1000) - The first name of the employee.
  • LastName: nvarchar(1000) - The last name of the employee.
  • EmploymentStatusCode: nvarchar(10) - The status code indicating the employment status of the employee. Full Time=ES01/Part Time=ES02.
  • CompanyJobCode: nvarchar(100) - The unique code assigned to the job within the company's system. This field is required.
  • CompanyJobTitle: Company Job title for this company job code, calculated by company job table in CompAnalyst.
  • StructureCode: nvarchar(100) - The structure code associated with the employee.
  • StructureName: The structure name of the structure code, calculated by salary structure defined in CompAnalyst.
  • SalaryPlanCode: nvarchar(100) - The salary plan code associated with the employee.
  • SalaryPlanName: The name of the salary plan, calculated by salary structure defined in CompAnalyst.
  • GradeCode: Grade code for an employee, , calculated by salary structure and company job of this employee defined in CompAnalyst.
  • GradeName: The name of the grade of the employee, calculated by salary structure defined in CompAnalyst.
  • RangeTypeCode: The code or identifier for the type of salary range defined in CompAnalyst, calculated by salary structure and company job of this employee defined in CompAnalyst.
  • RangeTypeName: The name of the range type, E.g. grade range/job range, calculated by salary structure and company job of this employee defined in CompAnalyst.
  • SalaryRangeMin: The minimum value of the salary range, calculated by salary structure and company job of this employee defined in CompAnalyst.
  • SalaryRangeMid: The midpoint value of the salary range, calculated by salary structure and company job of this employee defined in CompAnalyst.
  • SalaryRangeMax: The maximum value of the salary range, calculated by salary structure and company job of this employee defined in CompAnalyst.
  • ReportToEmployeeID: nvarchar(1000) - The identifier of the employee to whom this employee reports.
  • Email: nvarchar(1000) - The email address of the employee.
  • BaseSalary: money - Required field that specifies employee’s base salary. If this employee is Salaried, the number here should reflect their total annual base salary. (Refer to IsSalaried) If this employee is Hourly, the number here should reflect their base hourly rate. (Refer to IsSalaried)
  • Bonus: money - The bonus amount for the employee.
  • IsExempt: bit - Indicates whether the employee is exempt from certain labor regulations.1=Exempt; 0=Nonexempt.
  • IsOTEligible: bit - Indicates whether the employee is eligible for overtime pay.1=yes; 0=no.
  • AnnualWorkHours: int - The number of annual work hours for the employee.This should be total annual work hours regardless if the employee is Salary or Hourly.
  • HireDate: datetime - The date when the employee was hired.
  • SigningBonus: money - The signing bonus amount for the employee.
  • EmployeeCity: nvarchar(50) - Field that specifies employee’s working city.
  • EmployeeStateCode: nvarchar(50) - Specifies employee’s working state. Required field if country is USA.
  • EmployeeCountryCode: nvarchar(10) - Required field that specifies employee’s working country. Default value is 'USA', 3 digits country code.
  • EmployeeZipCode: nvarchar(10) - The working ZIP code of the employee.
  • CurrencyCode: nvarchar(10) - Required field used to designate what currency the compensation data is displayed in. Default value is 'USD'.
  • PerfRatingScaleCode: nvarchar(20) - The performance rating scale code for the employee, the precondition is the performance rating should be set up in the CompAnalyst.
  • PerfRangeNum: decimal(18,1) - Only use when your performance rating is set up as range. Field that specifies employee’s performance range number.
  • PerformanceNum: decimal(18,5) - The performance number of the employee, related to performance rating.
  • IsActive: bit - Indicates whether the employee is active.1=yes; 0=no.
  • TierCode: nvarchar(100) - Required field that links the employee to their appropriate market-pricing pay market. Must correspond to a previously specified value defined in CompAnalyst.
  • BonusTargetPercent: decimal(18,5) - Field that specifies employee’s bonus target percent.
  • BirthDate: datetime - Field that specifies employee date of birth.
  • Notes: nvarchar(500) - Field that specifies employee notes for CompAnalyst users.
  • TotalDirectCompensation: money - Field that specifies employee’s total direct compensation.
  • FixedPay: money - Field that specifies employee’s fixed pay.
  • Allow: money - Field that specifies employee’s allowance.
  • TGP: money - Field that specifies employee’s total guaranteed pay.
  • AVP: money - Field that specifies employee’s actual variable pay.
  • TVP: money - Field that specifies employee’s target variable pay.
  • TEC: money - Field that specifies employee’s total employment costs.
  • TotalLTIValue: money - Field that specifies employee’s long-term incentive value received.
  • DateStartedJob: datetime - The date when the employee started the current job.
  • TerminationDate: datetime - The job termination date of the employee.
  • SiteCode: nvarchar(200) - The code associated with the site where the employee works.
  • GenderCode: nvarchar(50) - The gender code of the employee.
  • EthnicityCode: nvarchar(200) - Field that specifies employee’s ethnicity. Coding system is based on user preference.
  • ShiftCode: nvarchar(100) - The shift code of the employee.
  • IsSalaried: bit - Required field that specifies if an employee is salaried. 1=salaried; 0=hourly.
  • LastReviewDate: datetime - The date of the employee's last review.
  • NextReviewDate: datetime - The date of the employee's next review.
  • LastUpdatedBy: nvarchar(100) - The user who last updated the employee record.
  • LTIValuationType: nvarchar(20) - Text Value describing Long-term incentive valuation type. Available options are as follows:
    • Black-Scholes
    • Binomial
    • Mod. Binomial
    • Mod. Black-Scholes
    • Lattice
  • OptionValue: money - Employee’s Stock Options.
  • RestStockValue: money - Employee’s Restricted Stock.
  • PhantStockValue: money - Employee’s Phantom Stock.
  • SARValue: money - Employee’s SARs (Stock Appreciation Rights).
  • PerfUnitValue: money - Employee’s Performance Units.
  • PerfShareValue: money - Employee’s Performance Shares.
  • LTCashValue: money - Employee’s Long-term Cash.
  • OtherLTIValue: money - Employee’s Other LTI Values.
  • TargetLTIValue: money - Employee’s Target LTI Values.
  • LTIPercentBase: decimal(18,5) - Decimal describing how the LTI value compares with an employee's base pay.
  • Race: nvarchar(50) - Field that specifies employee's race.
  • Location: nvarchar(100) - Field that specifies employee's location (will be only used in Pay Equity).
  • YearsOfPriorRelatedExp: int - Number Field that specifies employee's prior related experience.
  • EducationCode: nvarchar(10) - Field that specifies employee's education, only two available, high school or college
  • IsRemoteWorker: bit - Field that specifies whether employee is a remote worker or not. 1=yes; 0=no.
  • IsUnion: bit - Field that specifies whether employee belongs to a union or not. 1=yes; 0=no.
  • CertificationsLicenses: nvarchar(max) - Field that specifies employee's certifications or licenses.
  • Skills: nvarchar(max) - Field that specifies employee's competencies or skills.
  • PENotes: nvarchar(max) - Field that specifies other notes (used in pay equity module).
  • IsExcludedByPEA: bit - Field that specifies if employee is hidden from regression. 1=yes; 0=no.
  • Benefit: money - Benefit Contributions.
  • FourZeroOneK: money - 401(K) Employee Contribution.
  • OtherRewards: money - Other Rewards.
  • MedicalEE: money - Employee's Medical Insurance Contribution.
  • DentalEE: money - Employee's Dental Insurance Contribution.
  • VisionEE: money - Employee's Vision Insurance Contribution.
  • LifeEE: money - Employee's Life Insurance Contribution.
  • ADDEE: money - Employee's Accidental Death & Dismemberment Contribution.
  • STDEE: money - Employee's Short-Term Disability Insurance Contribution.
  • LTDEE: money - Employee's Long-Term Disability Insurance Contribution.
  • FICATaxSocialEE: money - Employee's FICA Social Security Contribution.
  • FICATaxMedicareEE: money - Employee's FICA Medicare Contribution.
  • MedicalER: money - Employer's Medical Insurance Contribution.
  • DentalER: money - Employer's Dental Insurance Contribution.
  • VisionER: money - Employer's Vision Insurance Contribution.
  • LifeER: money - Employer's Life Insurance Contribution.
  • ADDER: money - Employer's Accidental Death & Dismemberment Contribution.
  • STDER: money - Employer's Short-Term Disability Insurance Contribution.
  • LTDER: money - Employer's Long-Term Disability Insurance Contribution.
  • FourZeroOneKER: money - Employer's FICA Social Security Contribution.
  • TuitionReimbER: money - Employer's Tuition Reimbursement Contribution.
  • PhoneReimbER: money - Employer's Tuition Reimbursement Contribution.
  • FICATaxSocialER: money - Employer's FICA Social Security Contribution.
  • FICATaxMedicareER: money - Employer's FICA Medicare Contribution.
  • LTI1: Field that specifies if the employee is eligible for incentive stock options. 1=yes; 0=no.
  • LTI2: Field that specifies if the employee is eligible for non-qualified stock options. 1=yes; 0=no.
  • LTI3: Field that specifies if the employee is eligible for restricted stock. 1=yes; 0=no.
  • LTI4: Field that specifies if the employee is eligible for phantom stock. 1=yes; 0=no.
  • LTI5: Field that specifies if the employee is eligible for stock appreciation rights (SARs). 1=yes; 0=no.
  • LTI6: Field that specifies if the employee is eligible for performance units. 1=yes; 0=no.
  • LTI7: Field that specifies if the employee is eligible for performance shares. 1=yes; 0=no.
  • LTI8: Field that specifies if the employee is eligible for long-term cash. 1=yes; 0=no.
  • LTI9: Field that specifies if the organizational job is eligible for other Long-term incentives. 1=yes; 0=no.
  • UDFEmpTXL01: nvarchar(max) - User defined fields.
  • UDFEmpLST01 to UDFEmpLST10: nvarchar(500) - User defined fields.
  • UDFEmpTXS01 to UDFEmpTXS20: nvarchar(50) - User defined fields.
  • UDFEmpTXM01 to UDFEmpTXM53: nvarchar(100) - User defined fields.
  • UDFEmpDTM01 to UDFEmpDTM10: datetime - User defined fields.
  • UDFEmpMNY01 to UDFEmpMNY25: money - User defined fields.
  • UDFEmpDCM01 to UDFEmpDCM80: decimal(18,5) - User defined fields.
  • UDFEmpITG01 to UDFEmpITG10: int - User defined fields.
© Copyright Salary.com 2025. All Rights Reserved. Privacy Policy | Legal