> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a new PY Employee
> ## Overview
The Employee profile is a master record that not only retains employee demographic details but is central to populating employee default functionality for timesheet and payroll cost allocations. This endpoint is used to create and update employee records within the CMiC US Payroll Module.
## Notes
This POST method is used to both create and update records in CMiC; when updating, include the **Effective Date** and **Action Code** fields in the payload along with any other required updates.
To explicitly set a field value to NULL through the API, the following default values must be provided:
VARCHAR fields: Pass '\*'
DATE fields: Pass '9999-12-31'
For numeric fields, the value used to represent NULL varies by field. Refer to the description of each individual numeric field for the applicable NULL-indicator value.
## UI Navigation
Human Capital Management > Setup > Employees > Employee Profile
## Reference Article
[US Payroll – Employee Profile](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/PYU_-_US_Payroll/Reference/Employees/Employee_Profile.htm#Address)
## Required Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |
| --- | --- | --- | --- | --- | --- | --- | --- |
| Employee Number | pyemployee | EmpNo | This is the employee identification number in CMiC. If the 'Payroll/HR Auto Numbering' box has been checked in the Payroll tab of System Options (standard Treeview Path: System > Setup > System Options – Payroll tab), this field will not be accessible and the system will automatically number any new employees with the next available, sequential number. | string | 16 | 1 | Yes |
| Hire Date | pyemployee | EmpHireDate | This is the hire date of the employee. Format must be in YYYY-MM-DD | datetime | YYYY-MM-DD | 2025-10-28 | Yes |
| Date of Birth | pyemployee | EmpDateOfBirth | This is the birth date of the employee. Format must | datetime | YYYY-MM-DD | 1975-05-15 | Yes |
| Social Security Number (SSN) | pyemployee | EmpSinNo | This is the government issued Social Security Number/Social Insurance Number for the employee. Must be a valid number issued by the employee’s residing country. | string | 16 | ###-##-####, an example could be 123-45-6789 | Yes |
| First Name | pyemployee | EmpFirstName | This is the employee’s First Name | string | 60 | Dan | Yes |
| Last Name | pyemployee | EmpLastName | This is the employee’s Last Name. | string | 60 | Li | Yes |
| Status | pyemployee | EmpStatus | This is the employee’s status in CMiC. | string | 1 | A – ActiveT – TerminatedR – RetiredD – DeceasedS – SickU – Unpaid LeaveP – Paid LeaveL – Temporary LayoffO - Other | Yes |
| Type | pyemployee | EmpType | This identifies if the employee is an hourly or salaried employee. Hourly: Employees are paid based on hours entered in timesheets for the payroll period. Date sensitive pay rates, charge out, and billing rates for hourly employees can default from the Customer, Job, Trade, Union, or Employee Pay Rate screens (see the Pay Rates section for further details). If date sensitive pay rates are not required then static hourly, charge out, and billing rates can be entered in the Rates/Salary tab.Salaried: Timesheets are not required and employee wages are based on the annual salary entered on the Rates/Salary tab divided by the number of periods in the pay run. Timesheets can still be entered if payroll costs must be transferred to a job. | string | 1 | H – HourlyS - Salary | Yes |
| Eligibility Flag | pyemployee | EmpEligibilityFlag | This flag determines if the employee is eligible to record overtime on timesheets, | string | 1 | Y – EligibleN – Not Eligible | Yes |
| Flsa Type | pyemployee | EmpFlsaType | This flag determines if the employee is exempt from overtime. Employees are non-exempt by default. Non-exempt employees are entitled to work overtime, and their timesheets are included when processing overtime.By contrast, all timesheets for exempt employees validate the hours based on the employee pay run frequency and overtime hours are disallowed. For example, if the employee belongs to a weekly pay run, then timesheets do not allow entry of more than 40 normal working hours per week. | string | 1 | N – Non-ExemptY - Exempt | Yes |
| Benefit Type | pyemployee | EmpHemplType | | string | 10 | H- Hourly S- Salary | Yes |
| Unionized Flag | pyemployee | EmpUnionized | This flag determines if the employee is unionized. If checked Y, the EmpUniCode must also be created. The EmpUniCode must be a valid code in CMiC. | string | 1 | Y – UnionizedN – Not Unionized | Yes |
| Union Code | pyemployee | EmpUniCode | This field is required if EmpUnionized Flag is Y. | string | 30 | 1000 | Conditional Yes |
| Federal Filing Status | pyemployee | EmpFilingStatus | This is the employee’s W4 federal filing status. Must be a valid value in CMiC. | string | 2 | 01 – Single02 – Married03 – Head of Household16 – Married Filing Jointly62- Single or Married Filing Separately | Yes |
| State Filing Status | pyemployee | EmpStateFilingStatus | This is the employee’s W4 state filing status. Must be a valid value in CMiC and correspond with the State Code (EmpStateCode). See State Code for further details. | String | 2 | United StatesAlabama 01Alaska 02Arizona 03Arkansas 04California 05Colorado 06Connecticut 07Delaware 08District of Columbia 09Florida 10Georgia 11Hawaii 12Idaho 13Illnois 14Indiana 15Iowa 16Kansas 17Kentucky 18Louisiana 19Maine 20Maryland 21Massachusetts 22Michigan 23Minnesota 24Mississipi 25Missouri 26Montana 27Nebraska 28Nevada 29New Hampshire 30New Jersey 31New Mexico 32New York 33North Carolina 34North Dakota 35Ohio 36Oklahoma 37Oregon 38Pennyslvania 39Rhode Island 40South Carolina 41South Dakota 42Tennessee 43Texas 44Utah 45Vermont 46Virginia 47Washington 48West Virginia 49Wisconsin 50Wyoming 51American Samoa 60F.S. of Micronesia 61Guam 66Marshal Islands 67N. Mariana Islands 68Palau 69Puerto Rico 72United States Minor Outlying 1 74Virgin Islands 78 | Conditional Yes |
| State Code | pyemployee | EmpStateCode | This is the employee’s address state code. The code selected here will influence the employee’s State Filing Status (EmpStateFilingStatus) and State Filing Status should be updated for tax purposes. | string | 4 | AK – AlaskaAL – AlabamaAR – ArkansasAS – American SamoaAZ – ArizonaCA – CaliforniaCO – ColoradoCT – ConnecticutCZ – Canal ZoneDC – District of ColumbiaDE – DelawareFL – FloridaFM – Federated States of MicronesiaGA – GeorgiaGU – GuamHI – HawaiiIA – IowaID – IdahoIL – IllinoisIN – IndianaKS – KansasKY – KentuckyLA – LouisianaMA – MassachusettsMD – MarylandME – MaineMH – Marshall IslandsMI – MichiganMN – MinnesotaMO – MissouriMP – Northern Mariana IslandsMS – MississippiMT – MontanaNC – North CarolinaND – North DakotaNE – NebraskaNH – New HampshireNJ – New JerseyNM – New MexicoNV – NevadaNY – New YorkOH – OhioOK – OklahomaOR – OregonPA – PennsylvaniaPR – Puerto RicoPW – PalauRI – Rhode IslandSC – South CarolinaSD – South DakotaTN – TennesseeTX – TexasUT – UtahVA – VirginiaVI – Virgin IslandsVT – VermontWA – WashingtonWI – WisconsinWV – West VirginiaWY - Wyoming | Yes |
| Country Code | pyemployee | EmpCountryCode | This is the Country assigned on the employee address. | string | 4 | US – United States | Yes |
| Zip Code | pyemployee | EmpZipCode | This is the zip code of the employee’s address. | string | 13 | 92357 | Yes |
| Zip Plus 4 Code | pyemployee | EmpZipPlus4Code | This is the zip plus 4 code of the employee's address. | string | 4 | | |
| Physical Zip Plus 4 Code | pyemployee | EmpPhZipPlus4Code | This is the zip plus 4 code of employee's physical address | string | 4 | | |
| Phone Number | Pyemployee | EmpPhone | This is the employee’s home phone number. | string | 24 | 347-258-8945 | Yes |
| Work Phone Number | pyemployee | EmpWorkPhone | This is the employee’s work number. | string | 24 | 325-412-7895 | Yes |
| Cellphone Number | pyemployee | EmpCellPhone | This is the employee’s cell number. | string | 24 | 347-758-1112 | Yes |
| Work Email Address | pyemployee | EmpWorkEmailAddress | This is the employee’s work email address. This email address is used to manage ESS access for the employee. Should be a valid email address to receive ESS notifications. | string | 100 | [Dan.Li@constructioncompany.com](https://mailto:Dan.Li@constructioncompany.com) | Yes |
| Gender Code | pyemployee | EmpSex | This is the employee’s gender. Used for EEO-1 reporting. Must be a valid value in CMiC. | string | 1 | F- FemaleM- MaleU - Unknown | Yes |
| Marital Status Code | pyemployee | EmpMaritalStatus | This is the employee’s Marital Status, used for tax and benefit calculations. Must be a valid value in CMiC. | string | 1 | S – SingleM – MarriedC – Common Law | Yes |
| Military Status Code | pyemployee | EmpMilitaryStatus | This is the Military Status of the employee. Used in VETS-4212 reporting. Must be a valid Military Status in CMiC. | string | 20 | VE – VeteranNV – Not VeteranDV – Disabled VeteranVV – Vietnam VeteranMV – Service & Medal VeteranOV – Active Duty Wartime or Campaign Badge VeteranPV – Newly Separated VeteranIR – Inactive ReserveRR – Ready ReserveHV – Disability/HandicapNS – I do not wish to self-identify | Yes |
| Ethnicity Code | pyemployee | EmpEthnicCode | This is the Ethnic Code of the employee. Used in EEO-1 Component 1 reporting. Must be a valid Ethnicity in CMiC. | string | 2 | W – WhiteI – Aboriginal/IndigenousA – AsianB – Black/African AmericanH – Hispanic/LatinoX – Not applicableP – Hawaiian/Pacific IslanderM – Two or more races | Yes |
| Dominant Hand | pyemployee | EmpDominantHand | This is the employee’s dominant hand. Used for HR Safety module in CMiC. | string | 1 | R – RightL - Left | Yes |
| Employee Company Code | pyemployee | EmpComment | This is the employee’s payroll company. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 2000 | 10 | Yes |
| Home Company Code | pyemployee | EmpHomeCompCode | This is the reporting company of the employee; where the employee reports to work. Must be a valid company in CMiC. | string | 8 | 11 | Yes |
| Home Department Code | pyemployee | EmpHomeDeptCode | This is the employee’s reporting department. Must be a valid department in CMiC. | string | 6 | 10 – Project Management | Yes |
| Department Code | pyemployee | EmpDeptCode | This is the employee’s payroll department. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 6 | 01 - Payroll | Yes |
| Payrun Code | pyemployee | EmpPrnCode | This is the payroll run the employee belongs to. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 4 | WK – WeeklyBW – BiweeklyMN - Monthly | Yes |
| Trade Code | pyemployee | EmpTrdCode | This is the employee’s union classification in CMiC. Also used to identify non-union classification for building compensation hierarchies in CMiC. Must be a valid Trade in CMiC. | string | 30 | CARP - Carpenter | Yes |
| Timesheet Code | pyemployee | EmpTshCode | This is the time sheet code the employee record belongs to. Can match the Payrun Code. Must be a valid Timesheet Code in CMiC. | string | 4 | WK – WeeklyBW – BiweeklyMN - Monthly | Yes |
| Paygroup Code | pyemployee | EmpPygCode | This the payroll grouping the employee record is assigned to. Used for grouping time away (leaves), benefits and deductions in CMiC. Must be a valid Paygroup CMiC. | string | 4 | Hourly - HourlySalrd - SalariedCorp – CorporateUnion – UnionCont – ContractPT – Part-time | Yes |
| Workers Comp Code | pyemployee | EmpWcbCode | This is the workers’ compensation code assigned to the employee record. Must be a valid compensation code in CMiC. | string | 4 | 3224 – Millwright | Yes |
| Worklocation Code | pyemployee | EmpWrlCode | This is the work location the employee record belongs to. This is the work location used by the system for calculating taxes. Must be a valid work location in CMiC. | string | 15 | HQ – HeadquartersPT - Pittsburg | Yes |
| Annual Salary | pyemployee | EmpAnnualSalary | This the annual salary compensation amount. Although not a required field by default, if the EmpType value is ‘S’, then this field must be populated.
Pass 9999 to explicitly set the field value to NULL. | number | 18 | 42000.00 | Conditional Yes |
| Hourly Rate | pyemployee | EmpHourlyRate | This is the base compensation hourly rate assigned to the employee.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 25.00 | Yes |
| Charge out Rate | pyemployee | EmpChargeOutRate | This is the hourly charge rate assigned to the employee.The rate is used to post costs for jobs for the hours worked on those jobs. Also used by GC (General Conditions) Monitoring Module for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 30.00 | Yes |
| Billing Rate | pyemployee | EmpBillingRate | This is the hourly billing rate assigned to the employee. The rate used to post billing amounts against jobs for the hours worked on those jobs. Also used by GC (General Conditions) Monitoring Module for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 35.00 | Yes |
| GC Monitor Charge Rate | pyemployee | EmpGcChargeRate | This is GC (General Conditions) Monitor Charge Rate used in GC Monitor calculations for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 30.00 | Yes |
| GC Monitor Billing Rate | pyemployee | EmpGcBillRate | This is GC (General Conditions) Monitor Bill Rate used in GC Monitor calculations for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 35.00 | Yes |
| Rate Code | pyemployee | EmpRateCode | This is the normal (regular) rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | REG | Yes |
| Overtime Rate Code | pyemployee | EmpOtRateCode | This is the overtime rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | OVT | Yes |
| Doubletime Rate Code | pyemployee | EmpDotRateCode | This is the double-time rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | DVT | Yes |
| Other Rate Code | pyemployee | EmpOthRateCode | This is the other rate code assigned to the employee record. The other rate code is for other hour types outside of Normal, overtime and double time that are defined in the system. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | OTH | Yes |
| Effective Date | pyemployee | EmhEffectiveDate | This the effective date of when the employee record was created in CMiC. Also used as the ‘as of’ date to identify modifications made to the employee record. | datetime | YYYY-MM-DD | 2025-10-31 | Conditional Yes |
| Action Code | pyemployee | EmhActionCode | The action code is used by the system to identify the change being applied. This is a conditional field where other fields must also be updated/passed in the payload when and update is being made to a record. Must be a valid Action Code in CMiC. | string | 2 | CH – ChangeRH – RehireHR – HireT – TerminateTR – Transfer | Conditional Yes |
| Create Access Code Flag | pyemployee | EmpCreateAccessCode | This field is used to auto-generate a ID to be used in ESS e-timesheets for assigning timesheet privileges in ESS. If ‘Y’ value is passed will impact ESS E-time licenses available. | string | 1 | Y – auto- generate a Timesheet Access Code.N – do not auto-generate a Timesheet Access Code. | Yes |
| Employee User Login | pyemployee | EmpUser | This is the employee’s user ID in CMiC. Must be a valid System User in CMiC. | string | 30 | DLI | Yes |
| Security Group Code | pyemployee | EmpSecGrpEmpCode | This is the security group assigned to the employee record. Every employee must belong to a security group to be visible in the system when a user accesses that group. If left blank, the employee will not appear in payroll, even after setup. Once assigned, the employee will be visible in timesheets, payroll processing, and all related HR and payroll module screens. | string | 200 | FIELD | No |
## OpenAPI
````json POST /hcm-rest-api/rest/1/pyemployee
{
"openapi": "3.0.0",
"info": {
"title": "API Catalog",
"description": "",
"version": "1.0.0"
},
"servers": [
{
"url": "https://mobtest.cmiccloudr12.com/cmictestrti",
"description": "CMIC API Server"
}
],
"security": [
{
"cmicBasicAuth": []
}
],
"tags": [
{
"name": "Highlights"
},
{
"name": "Asset Management | Equipment"
},
{
"name": "Asset Management | Fixed Assets"
},
{
"name": "Asset Management | Purchase Order"
},
{
"name": "Asset Management | Inventory"
},
{
"name": "Asset Management | Requisition"
},
{
"name": "Asset Management | Purchase Change Order"
},
{
"name": "Bim Model"
},
{
"name": "Bim Model Revision"
},
{
"name": "Bim Tag Model"
},
{
"name": "Bim Tags"
},
{
"name": "Bim FileUpload Jersey"
},
{
"name": "Core System | Business Partners"
},
{
"name": "Core System | Business Partner Addresses"
},
{
"name": "Core System | Bank"
},
{
"name": "Core System | Currency"
},
{
"name": "Core System | Exchange Rates"
},
{
"name": "Core System | Global Table Text Codes"
},
{
"name": "Core System | Global Table Regions"
},
{
"name": "Core System | Terms"
},
{
"name": "Core System | System Contact"
},
{
"name": "Core System | Weight Measures"
},
{
"name": "Core System | Field User Defined Classifiers"
},
{
"name": "Core System | User Defined Classifiers by Object"
},
{
"name": "Core System | User Extension Definitions by Object"
},
{
"name": "Core System | User Extention Field Data Value"
},
{
"name": "Core System | User Extension Values by Object"
},
{
"name": "Core System | User System Role"
},
{
"name": "Core System | User Project Role"
},
{
"name": "Core System | Documents by Object"
},
{
"name": "Core System | Audit Status Log by Object"
},
{
"name": "Core System | Licensed Users"
},
{
"name": "Core System | Company Access"
},
{
"name": "Core System | Copy User Settings"
},
{
"name": "Core System | User Maintenance"
},
{
"name": "Core System | User Roles"
},
{
"name": "Core System | Security Groups"
},
{
"name": "Core System | Job/Project Security"
},
{
"name": "Core System | Weight Measure with Conversions Code"
},
{
"name": "Core System | Weight Measure Conversions Code"
},
{
"name": "Core System | User-defined-fields"
},
{
"name": "Core System | User-extension"
},
{
"name": "ECM and Workflow | Image Manager"
},
{
"name": "Financials | General Ledger"
},
{
"name": "Financials | Accounts Payable"
},
{
"name": "Financials | Accounts Receivable"
},
{
"name": "Preventative Maintenance | Issue Work Orders"
},
{
"name": "Preventative Maintenance | Issue Work Items"
},
{
"name": "Preventative Maintenance | Issue Work Budgets"
},
{
"name": "Preventative Maintenance | Issue Priorities"
},
{
"name": "Preventative Maintenance | Issue Status"
},
{
"name": "Preventative Maintenance | Issue Types"
},
{
"name": "Preventative Maintenance | Accumulative Equipment"
},
{
"name": "Preventative Maintenance | Work Orders"
},
{
"name": "Preventative Maintenance | Work Items"
},
{
"name": "Preventative Maintenance | Work Budgets"
},
{
"name": "Preventative Maintenance | Priorities"
},
{
"name": "Preventative Maintenance | Tasks"
},
{
"name": "HCM | UKG Pay Deductions"
},
{
"name": "HCM | UKG Pay Earnings"
},
{
"name": "HCM | UKG Pay Headers"
},
{
"name": "HCM | UKG Pay Taxes"
},
{
"name": "HCM | Payroll Geographical States"
},
{
"name": "HCM | Payroll Trades"
},
{
"name": "HCM | Payroll Union"
},
{
"name": "HCM | Payroll Pay Runs"
},
{
"name": "HCM | Payroll Pay Groups"
},
{
"name": "HCM | Payroll Tax"
},
{
"name": "HCM | Payroll Worker Compensation"
},
{
"name": "HCM | Payroll Work Locations"
},
{
"name": "HCM | Payroll Trade Pay Rates"
},
{
"name": "HCM | Payroll Union Pay Rates"
},
{
"name": "HCM | Payroll Job Pay Rates"
},
{
"name": "HCM | Payroll Master Benefits"
},
{
"name": "HCM | Payroll Master Deductions"
},
{
"name": "HCM | Payroll Ben/Ded/Leave Base Codes"
},
{
"name": "HCM | Payroll Ben/Ded Plans"
},
{
"name": "HCM | Payroll Ben/Ded Plan Options"
},
{
"name": "HCM | Payroll Company Benefits"
},
{
"name": "HCM | Payroll Company Deductions"
},
{
"name": "HCM | Payroll Vertex Geographic Locations"
},
{
"name": "HCM | Payroll Checks"
},
{
"name": "HCM | Payroll Timesheets"
},
{
"name": "HCM | Employee"
},
{
"name": "HCM | Employee (Minimum payload)"
},
{
"name": "HCM | Employee History"
},
{
"name": "HCM | Tax Exemptions"
},
{
"name": "HCM | Employee Tax Overrides"
},
{
"name": "HCM | Employee Pay Splits"
},
{
"name": "HCM | Employee Benefits"
},
{
"name": "HCM | Employee Clock In and Out"
},
{
"name": "HCM | Employee Deductions"
},
{
"name": "HCM | Employee Leaves"
},
{
"name": "HCM | Employee Leave History"
},
{
"name": "HCM | Employee Hour Types"
},
{
"name": "HCM | Employee Pay History"
},
{
"name": "HCM | Employee Work Statuses"
},
{
"name": "HCM | Employee Security Group"
},
{
"name": "HCM | Crewtime Crew"
},
{
"name": "HCM | Crewtime Employee Timesheet"
},
{
"name": "HCM | Crewtime Equipment Timesheet"
},
{
"name": "HCM | Crew Maintenance Activity Assignment"
},
{
"name": "HCM | Crew Maintenance Member Assignment"
},
{
"name": "HCM | Crew Maintenance Member Trade and Union Assignment"
},
{
"name": "HCM | Crew Maintenance Equipment Assignment"
},
{
"name": "HCM | Crew Maintenance Equipment Detail Assignment"
},
{
"name": "HCM | HR Requisitions"
},
{
"name": "HCM | HR Relations"
},
{
"name": "HCM | HR Employee Skills"
},
{
"name": "HCM | HR Incident"
},
{
"name": "HCM | HR Employee Relatives / Dependents"
},
{
"name": "HCM | HR Employee Positions"
},
{
"name": "HCM | HR Applicants"
},
{
"name": "HCM | HR Applications"
},
{
"name": "HCM | Vertex Location City"
},
{
"name": "HCM | HR Application History"
},
{
"name": "HCM | HR Dependent Benefits"
},
{
"name": "HCM | HR Dependent Deductions"
},
{
"name": "HCM | HR Employee Elected Plans"
},
{
"name": "HCM | HR Employee Training Certifications"
},
{
"name": "HCM | HR Trainings"
},
{
"name": "HCM | E-Timesheets"
},
{
"name": "HCM | System Contacts"
},
{
"name": "HCM | System User Payroll Security Group"
},
{
"name": "HCM | Payroll Timesheet Posting"
},
{
"name": "HCM | CrewTimesheet Posting"
},
{
"name": "HCM | HR Positions Master"
},
{
"name": "HCM | Payroll Pay Periods"
},
{
"name": "HCM | Payroll Rate Codes"
},
{
"name": "HCM | Payroll Overhead Codes and Rates"
},
{
"name": "HCM | Payroll Assigned Overhead to Jobs"
},
{
"name": "Materials Management | Material Sale Orders"
},
{
"name": "Materials Management | Material Sale Orders Details"
},
{
"name": "Materials Management | Truck Rate Detail"
},
{
"name": "Opportunity Management | Competitors"
},
{
"name": "Opportunity Management | Opportunities"
},
{
"name": "Opportunity Management | Revenue Details"
},
{
"name": "Opportunity Management | Opportunity History"
},
{
"name": "Opportunity Management | Organization"
},
{
"name": "Project Controls | Job Billing"
},
{
"name": "Project Controls | Job Cost"
},
{
"name": "Project Controls | PCI Details"
},
{
"name": "Project Controls | Unposted PCI Details"
},
{
"name": "Project Controls | PCI Headers"
},
{
"name": "Project Controls | Owner Change Orders"
},
{
"name": "Project Controls | CM Statuses"
},
{
"name": "Project Controls | CM Types"
},
{
"name": "Project Controls | CM Vendor Details"
},
{
"name": "Project Controls | Post PCI"
},
{
"name": "Project Management | Uploading Documents"
},
{
"name": "Project Management | Downloading Documents"
},
{
"name": "Project Management | Foreign Bid Item Imports"
},
{
"name": "Project Management | Communications"
},
{
"name": "Project Management | Daily Journals"
},
{
"name": "Project Management | Communications Types"
},
{
"name": "Project Management | Daily Journal Daily Work Plans"
},
{
"name": "Project Management | Daily Journal Field Forces"
},
{
"name": "Project Management | Daily Journal Labour"
},
{
"name": "Project Management | Daily Journal Materials"
},
{
"name": "Project Management | Daily Journal Owner Equipment"
},
{
"name": "Project Management | Daily Journal Quality Control"
},
{
"name": "Project Management | Daily Journal Tasks"
},
{
"name": "Project Management | Daily Journal Trade Equipment"
},
{
"name": "Project Management | Daily Journal Transactions"
},
{
"name": "Project Management | Daily Journal User Defined Data"
},
{
"name": "Project Management | Daily Journal Visitors"
},
{
"name": "Project Management | Daily Journal Bill Details"
},
{
"name": "Project Management | Field Work Directives"
},
{
"name": "Project Management | Contract Types"
},
{
"name": "Project Management | Company Contacts"
},
{
"name": "Project Management | Distribution BCC"
},
{
"name": "Project Management | Distribution CC"
},
{
"name": "Project Management | Field Work Directive Statuses"
},
{
"name": "Project Management | Issues"
},
{
"name": "Project Management | Key Players"
},
{
"name": "Project Management | Meetings"
},
{
"name": "Project Management | Meeting Attendees"
},
{
"name": "Project Management | Meeting Item Statuses"
},
{
"name": "Project Management | Meeting Tracks"
},
{
"name": "Project Management | Notes"
},
{
"name": "Project Management | Projects"
},
{
"name": "Project Management | Project Items"
},
{
"name": "Project Management | Project Item Phase Segment Sums"
},
{
"name": "Project Management | Project Partners"
},
{
"name": "Project Management | Notices"
},
{
"name": "Project Management | Notice Statuses"
},
{
"name": "Project Management | Owner JS Query"
},
{
"name": "Project Management | PCI Real Locations"
},
{
"name": "Project Management | Project Contacts"
},
{
"name": "Project Management | RFIs (Requests for Information)"
},
{
"name": "Project Management | RFI Statuses"
},
{
"name": "Project Management | Submittal Packages"
},
{
"name": "Project Management | Submittal Package Details"
},
{
"name": "Project Management | Submittal Package Status"
},
{
"name": "Project Management | Submittals"
},
{
"name": "Project Management | Submittal Status"
},
{
"name": "Project Management | Transmittals"
},
{
"name": "Project Management | Subcontract Headers"
},
{
"name": "Project Management | Subcontract Schedules"
},
{
"name": "Project Management | Subcontract Sechedule Phase Segment Sums"
},
{
"name": "Project Management | User Roles"
},
{
"name": "Project Management | Punchlists"
},
{
"name": "Project Management | Punchlist Details"
},
{
"name": "Project Management | Punchlist Statuses"
},
{
"name": "Project Management | Meeting Items"
},
{
"name": "Project Management | Self Perform Vendor"
},
{
"name": "Project Management | Submittal Types"
},
{
"name": "Project Management | Assign contact and partner to project"
},
{
"name": "Project Management | Subcontract Prequal"
},
{
"name": "Project Management | Bid Item Package"
}
],
"paths": {
"/hcm-rest-api/rest/1/pyemployee": {
"post": {
"tags": [
"HCM | Employee"
],
"summary": "Create a new PY Employee",
"description": "## Overview\n\nThe Employee profile is a master record that not only retains employee demographic details but is central to populating employee default functionality for timesheet and payroll cost allocations. This endpoint is used to create and update employee records within the CMiC US Payroll Module.\n\n## Notes\n\nThis POST method is used to both create and update records in CMiC; when updating, include the **Effective Date** and **Action Code** fields in the payload along with any other required updates.\n\nTo explicitly set a field value to NULL through the API, the following default values must be provided:\n\nVARCHAR fields: Pass '\\*' \nDATE fields: Pass '9999-12-31'\n\nFor numeric fields, the value used to represent NULL varies by field. Refer to the description of each individual numeric field for the applicable NULL-indicator value.\n\n## UI Navigation\n\nHuman Capital Management > Setup > Employees > Employee Profile\n\n## Reference Article\n\n[US Payroll – Employee Profile](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/PYU_-_US_Payroll/Reference/Employees/Employee_Profile.htm#Address)\n\n## Required Body Parameters\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n| Employee Number | pyemployee | EmpNo | This is the employee identification number in CMiC. If the 'Payroll/HR Auto Numbering' box has been checked in the Payroll tab of System Options (standard Treeview Path: System > Setup > System Options – Payroll tab), this field will not be accessible and the system will automatically number any new employees with the next available, sequential number. | string | 16 | 1 | Yes |\n| Hire Date | pyemployee | EmpHireDate | This is the hire date of the employee. Format must be in YYYY-MM-DD | datetime | YYYY-MM-DD | 2025-10-28 | Yes |\n| Date of Birth | pyemployee | EmpDateOfBirth | This is the birth date of the employee. Format must | datetime | YYYY-MM-DD | 1975-05-15 | Yes |\n| Social Security Number (SSN) | pyemployee | EmpSinNo | This is the government issued Social Security Number/Social Insurance Number for the employee. Must be a valid number issued by the employee’s residing country. | string | 16 | ###-##-####, an example could be 123-45-6789 | Yes |\n| First Name | pyemployee | EmpFirstName | This is the employee’s First Name | string | 60 | Dan | Yes |\n| Last Name | pyemployee | EmpLastName | This is the employee’s Last Name. | string | 60 | Li | Yes |\n| Status | pyemployee | EmpStatus | This is the employee’s status in CMiC. | string | 1 | A – ActiveT – TerminatedR – RetiredD – DeceasedS – SickU – Unpaid LeaveP – Paid LeaveL – Temporary LayoffO - Other | Yes |\n| Type | pyemployee | EmpType | This identifies if the employee is an hourly or salaried employee. Hourly: Employees are paid based on hours entered in timesheets for the payroll period. Date sensitive pay rates, charge out, and billing rates for hourly employees can default from the Customer, Job, Trade, Union, or Employee Pay Rate screens (see the Pay Rates section for further details). If date sensitive pay rates are not required then static hourly, charge out, and billing rates can be entered in the Rates/Salary tab.Salaried: Timesheets are not required and employee wages are based on the annual salary entered on the Rates/Salary tab divided by the number of periods in the pay run. Timesheets can still be entered if payroll costs must be transferred to a job. | string | 1 | H – HourlyS - Salary | Yes |\n| Eligibility Flag | pyemployee | EmpEligibilityFlag | This flag determines if the employee is eligible to record overtime on timesheets, | string | 1 | Y – EligibleN – Not Eligible | Yes |\n| Flsa Type | pyemployee | EmpFlsaType | This flag determines if the employee is exempt from overtime. Employees are non-exempt by default. Non-exempt employees are entitled to work overtime, and their timesheets are included when processing overtime.By contrast, all timesheets for exempt employees validate the hours based on the employee pay run frequency and overtime hours are disallowed. For example, if the employee belongs to a weekly pay run, then timesheets do not allow entry of more than 40 normal working hours per week. | string | 1 | N – Non-ExemptY - Exempt | Yes |\n| Benefit Type | pyemployee | EmpHemplType | | string | 10 | H- Hourly S- Salary | Yes |\n| Unionized Flag | pyemployee | EmpUnionized | This flag determines if the employee is unionized. If checked Y, the EmpUniCode must also be created. The EmpUniCode must be a valid code in CMiC. | string | 1 | Y – UnionizedN – Not Unionized | Yes |\n| Union Code | pyemployee | EmpUniCode | This field is required if EmpUnionized Flag is Y. | string | 30 | 1000 | Conditional Yes |\n| Federal Filing Status | pyemployee | EmpFilingStatus | This is the employee’s W4 federal filing status. Must be a valid value in CMiC. | string | 2 | 01 – Single02 – Married03 – Head of Household16 – Married Filing Jointly62- Single or Married Filing Separately | Yes |\n| State Filing Status | pyemployee | EmpStateFilingStatus | This is the employee’s W4 state filing status. Must be a valid value in CMiC and correspond with the State Code (EmpStateCode). See State Code for further details. | String | 2 | United StatesAlabama 01Alaska 02Arizona 03Arkansas 04California 05Colorado 06Connecticut 07Delaware 08District of Columbia 09Florida 10Georgia 11Hawaii 12Idaho 13Illnois 14Indiana 15Iowa 16Kansas 17Kentucky 18Louisiana 19Maine 20Maryland 21Massachusetts 22Michigan 23Minnesota 24Mississipi 25Missouri 26Montana 27Nebraska 28Nevada 29New Hampshire 30New Jersey 31New Mexico 32New York 33North Carolina 34North Dakota 35Ohio 36Oklahoma 37Oregon 38Pennyslvania 39Rhode Island 40South Carolina 41South Dakota 42Tennessee 43Texas 44Utah 45Vermont 46Virginia 47Washington 48West Virginia 49Wisconsin 50Wyoming 51American Samoa 60F.S. of Micronesia 61Guam 66Marshal Islands 67N. Mariana Islands 68Palau 69Puerto Rico 72United States Minor Outlying 1 74Virgin Islands 78 | Conditional Yes |\n| State Code | pyemployee | EmpStateCode | This is the employee’s address state code. The code selected here will influence the employee’s State Filing Status (EmpStateFilingStatus) and State Filing Status should be updated for tax purposes. | string | 4 | AK – AlaskaAL – AlabamaAR – ArkansasAS – American SamoaAZ – ArizonaCA – CaliforniaCO – ColoradoCT – ConnecticutCZ – Canal ZoneDC – District of ColumbiaDE – DelawareFL – FloridaFM – Federated States of MicronesiaGA – GeorgiaGU – GuamHI – HawaiiIA – IowaID – IdahoIL – IllinoisIN – IndianaKS – KansasKY – KentuckyLA – LouisianaMA – MassachusettsMD – MarylandME – MaineMH – Marshall IslandsMI – MichiganMN – MinnesotaMO – MissouriMP – Northern Mariana IslandsMS – MississippiMT – MontanaNC – North CarolinaND – North DakotaNE – NebraskaNH – New HampshireNJ – New JerseyNM – New MexicoNV – NevadaNY – New YorkOH – OhioOK – OklahomaOR – OregonPA – PennsylvaniaPR – Puerto RicoPW – PalauRI – Rhode IslandSC – South CarolinaSD – South DakotaTN – TennesseeTX – TexasUT – UtahVA – VirginiaVI – Virgin IslandsVT – VermontWA – WashingtonWI – WisconsinWV – West VirginiaWY - Wyoming | Yes |\n| Country Code | pyemployee | EmpCountryCode | This is the Country assigned on the employee address. | string | 4 | US – United States | Yes |\n| Zip Code | pyemployee | EmpZipCode | This is the zip code of the employee’s address. | string | 13 | 92357 | Yes |\n| Zip Plus 4 Code | pyemployee | EmpZipPlus4Code | This is the zip plus 4 code of the employee's address. | string | 4 | | |\n| Physical Zip Plus 4 Code | pyemployee | EmpPhZipPlus4Code | This is the zip plus 4 code of employee's physical address | string | 4 | | |\n| Phone Number | Pyemployee | EmpPhone | This is the employee’s home phone number. | string | 24 | 347-258-8945 | Yes |\n| Work Phone Number | pyemployee | EmpWorkPhone | This is the employee’s work number. | string | 24 | 325-412-7895 | Yes |\n| Cellphone Number | pyemployee | EmpCellPhone | This is the employee’s cell number. | string | 24 | 347-758-1112 | Yes |\n| Work Email Address | pyemployee | EmpWorkEmailAddress | This is the employee’s work email address. This email address is used to manage ESS access for the employee. Should be a valid email address to receive ESS notifications. | string | 100 | [Dan.Li@constructioncompany.com](https://mailto:Dan.Li@constructioncompany.com) | Yes |\n| Gender Code | pyemployee | EmpSex | This is the employee’s gender. Used for EEO-1 reporting. Must be a valid value in CMiC. | string | 1 | F- FemaleM- MaleU - Unknown | Yes |\n| Marital Status Code | pyemployee | EmpMaritalStatus | This is the employee’s Marital Status, used for tax and benefit calculations. Must be a valid value in CMiC. | string | 1 | S – SingleM – MarriedC – Common Law | Yes |\n| Military Status Code | pyemployee | EmpMilitaryStatus | This is the Military Status of the employee. Used in VETS-4212 reporting. Must be a valid Military Status in CMiC. | string | 20 | VE – VeteranNV – Not VeteranDV – Disabled VeteranVV – Vietnam VeteranMV – Service & Medal VeteranOV – Active Duty Wartime or Campaign Badge VeteranPV – Newly Separated VeteranIR – Inactive ReserveRR – Ready ReserveHV – Disability/HandicapNS – I do not wish to self-identify | Yes |\n| Ethnicity Code | pyemployee | EmpEthnicCode | This is the Ethnic Code of the employee. Used in EEO-1 Component 1 reporting. Must be a valid Ethnicity in CMiC. | string | 2 | W – WhiteI – Aboriginal/IndigenousA – AsianB – Black/African AmericanH – Hispanic/LatinoX – Not applicableP – Hawaiian/Pacific IslanderM – Two or more races | Yes |\n| Dominant Hand | pyemployee | EmpDominantHand | This is the employee’s dominant hand. Used for HR Safety module in CMiC. | string | 1 | R – RightL - Left | Yes |\n| Employee Company Code | pyemployee | EmpComment | This is the employee’s payroll company. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 2000 | 10 | Yes |\n| Home Company Code | pyemployee | EmpHomeCompCode | This is the reporting company of the employee; where the employee reports to work. Must be a valid company in CMiC. | string | 8 | 11 | Yes |\n| Home Department Code | pyemployee | EmpHomeDeptCode | This is the employee’s reporting department. Must be a valid department in CMiC. | string | 6 | 10 – Project Management | Yes |\n| Department Code | pyemployee | EmpDeptCode | This is the employee’s payroll department. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 6 | 01 - Payroll | Yes |\n| Payrun Code | pyemployee | EmpPrnCode | This is the payroll run the employee belongs to. Used for allocating payroll expenses during payroll processing and committing. Must be a valid Payroll Company in CMiC. | string | 4 | WK – WeeklyBW – BiweeklyMN - Monthly | Yes |\n| Trade Code | pyemployee | EmpTrdCode | This is the employee’s union classification in CMiC. Also used to identify non-union classification for building compensation hierarchies in CMiC. Must be a valid Trade in CMiC. | string | 30 | CARP - Carpenter | Yes |\n| Timesheet Code | pyemployee | EmpTshCode | This is the time sheet code the employee record belongs to. Can match the Payrun Code. Must be a valid Timesheet Code in CMiC. | string | 4 | WK – WeeklyBW – BiweeklyMN - Monthly | Yes |\n| Paygroup Code | pyemployee | EmpPygCode | This the payroll grouping the employee record is assigned to. Used for grouping time away (leaves), benefits and deductions in CMiC. Must be a valid Paygroup CMiC. | string | 4 | Hourly - HourlySalrd - SalariedCorp – CorporateUnion – UnionCont – ContractPT – Part-time | Yes |\n| Workers Comp Code | pyemployee | EmpWcbCode | This is the workers’ compensation code assigned to the employee record. Must be a valid compensation code in CMiC. | string | 4 | 3224 – Millwright | Yes |\n| Worklocation Code | pyemployee | EmpWrlCode | This is the work location the employee record belongs to. This is the work location used by the system for calculating taxes. Must be a valid work location in CMiC. | string | 15 | HQ – HeadquartersPT - Pittsburg | Yes |\n| Annual Salary | pyemployee | EmpAnnualSalary | This the annual salary compensation amount. Although not a required field by default, if the EmpType value is ‘S’, then this field must be populated.
Pass 9999 to explicitly set the field value to NULL. | number | 18 | 42000.00 | Conditional Yes |\n| Hourly Rate | pyemployee | EmpHourlyRate | This is the base compensation hourly rate assigned to the employee.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 25.00 | Yes |\n| Charge out Rate | pyemployee | EmpChargeOutRate | This is the hourly charge rate assigned to the employee.The rate is used to post costs for jobs for the hours worked on those jobs. Also used by GC (General Conditions) Monitoring Module for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 30.00 | Yes |\n| Billing Rate | pyemployee | EmpBillingRate | This is the hourly billing rate assigned to the employee. The rate used to post billing amounts against jobs for the hours worked on those jobs. Also used by GC (General Conditions) Monitoring Module for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 35.00 | Yes |\n| GC Monitor Charge Rate | pyemployee | EmpGcChargeRate | This is GC (General Conditions) Monitor Charge Rate used in GC Monitor calculations for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 30.00 | Yes |\n| GC Monitor Billing Rate | pyemployee | EmpGcBillRate | This is GC (General Conditions) Monitor Bill Rate used in GC Monitor calculations for forecasting productivity costs.
Pass 9999 to explicitly set the field value to NULL. | number | 16 | 35.00 | Yes |\n| Rate Code | pyemployee | EmpRateCode | This is the normal (regular) rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | REG | Yes |\n| Overtime Rate Code | pyemployee | EmpOtRateCode | This is the overtime rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | OVT | Yes |\n| Doubletime Rate Code | pyemployee | EmpDotRateCode | This is the double-time rate code assigned to the employee record. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | DVT | Yes |\n| Other Rate Code | pyemployee | EmpOthRateCode | This is the other rate code assigned to the employee record. The other rate code is for other hour types outside of Normal, overtime and double time that are defined in the system. It is used by the system to automatically apply the correct rate when calculating dollar amounts from hourly timesheets. Must be a valid Rate Code in CMiC. | string | 4 | OTH | Yes |\n| Effective Date | pyemployee | EmhEffectiveDate | This the effective date of when the employee record was created in CMiC. Also used as the ‘as of’ date to identify modifications made to the employee record. | datetime | YYYY-MM-DD | 2025-10-31 | Conditional Yes |\n| Action Code | pyemployee | EmhActionCode | The action code is used by the system to identify the change being applied. This is a conditional field where other fields must also be updated/passed in the payload when and update is being made to a record. Must be a valid Action Code in CMiC. | string | 2 | CH – ChangeRH – RehireHR – HireT – TerminateTR – Transfer | Conditional Yes |\n| Create Access Code Flag | pyemployee | EmpCreateAccessCode | This field is used to auto-generate a ID to be used in ESS e-timesheets for assigning timesheet privileges in ESS. If ‘Y’ value is passed will impact ESS E-time licenses available. | string | 1 | Y – auto- generate a Timesheet Access Code.N – do not auto-generate a Timesheet Access Code. | Yes |\n| Employee User Login | pyemployee | EmpUser | This is the employee’s user ID in CMiC. Must be a valid System User in CMiC. | string | 30 | DLI | Yes |\n| Security Group Code | pyemployee | EmpSecGrpEmpCode | This is the security group assigned to the employee record. Every employee must belong to a security group to be visible in the system when a user accesses that group. If left blank, the employee will not appear in payroll, even after setup. Once assigned, the employee will be visible in timesheets, payroll processing, and all related HR and payroll module screens. | string | 200 | FIELD | No |",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"EmpNo": "GEO-TEST-053",
"EmpPrimaryEmpNo": "GEO-TEST-053",
"EmpUser": "DA",
"EmpFirstName": "API",
"EmpLastName": "Test",
"EmpSinNo": "331601053",
"EmpStatus": "A",
"EmpDateOfBirth": "2000-01-01",
"EmpHireDate": "2023-10-03",
"EmpCompCode": "ZZ",
"EmpDeptCode": "00",
"EmpPrnCode": "ZZWK",
"EmpPygCode": "WK",
"EmpTrdCode": "ZZ10",
"EmpWrlCode": "ZCHI",
"EmpHourlyRate": 50,
"EmpChargeOutRate": 100,
"EmpBillingRate": 150,
"EmpSecGrpEmpCode": "MASTER",
"EmpFilingStatus": "02",
"EmpVUuid": "",
"EmpCountryCode": "US",
"EmpStateCode": "OH",
"EmpZipCode": "43055",
"EmpAddress3": "Newark",
"EmpCalcPref": "S",
"EmpResLoc": "SNY",
"EmpFullName": "Liam Kinder",
"EmpFlsaType": "N",
"EmpHemplYearlySal": 0,
"EmpHemplType": "H",
"EmpLastTshJobCode": "ZZ-SWJOB",
"EmpVertexGeocodeSource": "M",
"EmpType": "S",
"EmpFullPartTime": "F",
"EmpSubStatus": "W",
"EmpCalcAccruedLeave": "Y",
"EmpUnionized": "N",
"EmpRehireEligible": "Y",
"EmpAdjustedSeriviceDate": "2005-01-01",
"EmpYearWorkingDays": 260,
"EmpYearWorkingHours": 2080,
"EmpUeValidFlag": "Y",
"EmpHomeDeptCode": "00",
"EmpGlAccCode": "6000.100",
"EmpPayrollClearAccCode": "6000.200",
"EmpDrClearAccCode": "6000.200",
"EmpLevAcruGlAccCode": "6002.101",
"EmpLevClearAccCode": "6002.101",
"EmpTshCode": "ZZWK",
"EmpWcbCode": "WC",
"EmpPlCode": "PL",
"EmpPlName": "Public Liab NY",
"EmpWcbByJob": "Y",
"EmpPlByJob": "Y",
"EmpWrlFlag": "Y",
"EmpExcpInclFlag": "N",
"EmpInclCertPyRepFlag": "Y",
"EmpAutogenerateTimesheet": "Y",
"EmpDispatchFlag": "N",
"EmpAnnualSalary": 80000,
"EmpRateCode": "Z100",
"EmpOtRateCode": "Z200",
"EmpDotRateCode": "Z300",
"EmpOthRateCode": "Z400",
"EmpPreferPayRate": "J",
"EmpPreferChargeRate": "J",
"EmpPreferBillRate": "J",
"EmpDirectDepMethod": "M",
"EmpJobCompCode": "ZZ",
"EmpEmailAddress": "william.palo@cmic.ca",
"EmpPrefContactMth": "E",
"EmpResidentStatus": "C",
"EmpPrimExemp": 0,
"EmpNrCertificate": "Y",
"EmpSex": "M",
"EmpMaritalStatus": "S",
"EmpEthnicCode": "W",
"EmpMilitaryStatus": "NV",
"EmpDominantHand": "R",
"EmpLeaveCalcPref": "R"
}
}
}
}
},
"parameters": [
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/vnd.oracle.adf.resourceItem+json"
}
],
"responses": {
"201": {
"description": "Created",
"headers": {
"Content-Type": {
"schema": {
"type": "string",
"example": "application/vnd.oracle.adf.resourceitem+json"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"EmpNo": "GEO-TEST-053",
"EmpCalcPref": "S",
"EmpComment": null,
"EmpResLoc": "SNY",
"EmpOtEligibility": null,
"EmpPaymentMode": null,
"EmpLastIncrDate": null,
"EmpLastPromDate": null,
"EmpLastTranDate": null,
"EmpUser": "DA",
"EmpIuCreateDatetime": null,
"EmpIuUpdateDatetime": null,
"EmpLastUpdDate": null,
"EmpTd1ExempAmt": null,
"EmpEiCode": null,
"EmpAdpFilingStatus": null,
"EmpCreateDate": null,
"EmpSseFlag": null,
"EmpTd1ExempFlag": null,
"EmpEligibilityFlag": null,
"EmpHardshipSuspFlag": null,
"EmpSecGrpEmpCode": null,
"EmpSecGrpEmpName": null,
"EmpFlsaType": "N",
"EmpHemplYearlySal": 0,
"EmpHemplType": "H",
"EmpHasCert": null,
"EmpHasSkill": null,
"EmpHrrTypeCode": null,
"EmpHrrTypeDesc": null,
"EmpLastTshJobCompCode": null,
"EmpLastTshJobCode": null,
"EmpLastTshJobDesc": null,
"EmpWorkCellPhone": null,
"EmpWorkEmailAddress": null,
"EmpVertexGeocodeSource": "M",
"EmpAddressForeignFlag": null,
"EmpPhAddressForeignFlag": null,
"EmpPhCountryCode": null,
"EmpPhCountryName": null,
"EmpPhStateCode": null,
"EmpPhStateName": null,
"EmpReportsTo": null,
"EmpReportsToName": null,
"EmpFullName": "Liam Kinder",
"EmpFirstName": "API",
"EmpMiddleName": null,
"EmpLastName": "Test",
"EmpPrefixName": null,
"EmpSuffixName": null,
"EmpNickName": null,
"EmpSinNo": "331601053",
"EmpType": "S",
"EmpFullPartTime": "F",
"EmpStatus": "A",
"EmpStatusDesc": "Active",
"EmpSubStatus": "W",
"EmpCalcAccruedLeave": "Y",
"EmpUnionized": "N",
"EmpMembershipDate": null,
"EmpRehireEligible": "Y",
"EmpUniCode": null,
"EmpUniName": null,
"EmpUnionMemNo": null,
"EmpJobTitle": null,
"EmpPlaceOfBirth": null,
"EmpDateOfBirth": "2000-01-01",
"EmpHireDate": "2023-10-03",
"EmpTerminationDate": null,
"EmpReHireDate": null,
"EmpDateDeceased": null,
"EmpSeniorityDate": null,
"EmpNextReviewDate": null,
"EmpAdjustedSeriviceDate": "2005-01-01",
"EmpPrimaryEmpNo": "GEO-TEST-053",
"EmpYearWorkingDays": 260,
"EmpYearWorkingHours": 2080,
"EmpServiceYears": 0,
"EmpUeValidFlag": "Y",
"EmpCompCode": "ZZ",
"EmpCompName": null,
"EmpHomeCompCode": "ZZ",
"EmpHomeCompName": null,
"EmpDeptCode": "00",
"EmpDeptName": null,
"EmpHomeDeptCode": "00",
"EmpHomeDeptName": null,
"EmpGlAccCode": "6000.100",
"EmpGlAccName": null,
"EmpPayrollClearAccCode": "6000.200",
"EmpPayrollClearAccName": null,
"EmpDrClearAccCode": "6000.200",
"EmpDrClearAccName": null,
"EmpLevAcruGlAccCode": "6002.101",
"EmpLevAcruGlAccName": null,
"EmpLevClearAccCode": "6002.101",
"EmpLevClearAccName": null,
"EmpPrnCode": "ZZWK",
"EmpPrnName": null,
"EmpPygCode": "WK",
"EmpPygName": null,
"EmpWrlCode": "ZCHI",
"EmpWrlName": null,
"EmpGrdCode": null,
"EmpGrdName": null,
"EmpTrdCode": "ZZ10",
"EmpTrdName": null,
"EmpExpAprvGrpCode": null,
"EmpExpAprvGrpName": null,
"EmpTshCode": "ZZWK",
"EmpTshName": null,
"EmpCklocCode": null,
"EmpCklocName": null,
"EmpWcbCode": "WC",
"EmpWcbName": null,
"EmpPlCode": "PL",
"EmpPlName": "Public Liab NY",
"EmpWcbByJob": "Y",
"EmpPlByJob": "Y",
"EmpWrlFlag": "Y",
"EmpExcpInclFlag": "N",
"EmpInclCertPyRepFlag": "Y",
"EmpAutogenerateTimesheet": "Y",
"EmpDispatchFlag": "N",
"EmpAnnualSalary": 80000,
"EmpHourlyRate": 50,
"EmpChargeOutRate": 100,
"EmpBillingRate": 150,
"EmpRateCode": "Z100",
"EmpRateName": null,
"EmpOtRateCode": "Z200",
"EmpOtRateName": null,
"EmpDotRateCode": "Z300",
"EmpDotRateName": null,
"EmpOthRateCode": "Z400",
"EmpOthRateName": null,
"EmpPreferPayRate": "J",
"EmpPreferChargeRate": "J",
"EmpPreferBillRate": "J",
"EmpDirectDepMethod": "M",
"EmpDirectDepEmail": null,
"EmpMinHourCode": null,
"EmpUserEnteredOt": null,
"EmpUserEnteredDt": null,
"EmpJobCompCode": "ZZ",
"EmpJobCompName": null,
"EmpJobCode": null,
"EmpJobName": null,
"EmpPhsCode": null,
"EmpPhsName": null,
"EmpCatCode": null,
"EmpCatName": null,
"EmpEquipmentNo": null,
"EmpEquipmentName": null,
"EmpEquipPhsCode": null,
"EmpEquipPhsName": null,
"EmpEquipCategory": null,
"EmpEquipCatName": null,
"EmpEquipTranCode": null,
"EmpEquipTranName": null,
"EmpAddress1": null,
"EmpAddress2": null,
"EmpAddress3": "Newark",
"EmpZipCode": "43055",
"EmpPhAddress1": null,
"EmpPhAddress2": null,
"EmpPhAddress3": null,
"EmpPhZipCode": null,
"EmpCountryCode": "US",
"EmpCountryName": null,
"EmpStateCode": "OH",
"EmpStateName": null,
"EmpCountyCode": null,
"EmpCountyName": null,
"EmpCityCode": null,
"EmpCityName": null,
"EmpPhone": null,
"EmpWorkPhone": null,
"EmpCellPhone": null,
"EmpPager": null,
"EmpFax": null,
"EmpWorkFax": null,
"EmpEmailAddress": "william.palo@cmic.ca",
"EmpResLatitude": null,
"EmpResLongitude": null,
"EmpBpCode": null,
"EmpPrefContactMth": "E",
"EmpVertexGeocode": null,
"EmpVertexSchdist": null,
"EmpResidentStatus": "C",
"EmpFilingStatus": "02",
"EmpFilingStatusName": null,
"EmpStateFilingStatus": null,
"EmpStateFilingStatusName": null,
"EmpCityFilingStatus": null,
"EmpCityFilingStatusName": null,
"EmpPrimExemp": 0,
"EmpSecnExemp": null,
"EmpTertExemp": null,
"EmpPrimExempAmt": null,
"EmpSuplExempAmt": null,
"EmpSuiState": null,
"EmpSuiStateName": null,
"EmpNrCertificate": "Y",
"EmpPensionFlag": null,
"EmpDefCompFlag": null,
"EmpAddrCompCode": null,
"EmpAddrCode": null,
"EmpAddrName": null,
"EmpRegCompCode": null,
"EmpRegionCode": null,
"EmpRegionName": null,
"EmpPosCode": null,
"EmpPosName": null,
"EmpDisabilityDisCode": null,
"EmpDisabilityDisName": null,
"EmpTravelFlag": null,
"EmpTravelDistance": null,
"EmpLanguageLangName": null,
"EmpApplicantAplNo": null,
"EmpLoginUser": null,
"EmpSex": "M",
"EmpMaritalStatus": "S",
"EmpEthnicCode": "W",
"EmpMilitaryStatus": "NV",
"EmpMilitarySeparationDate": null,
"EmpDominantHand": "R",
"EmpLeaveCalcPref": "R",
"EmhActionCode": null,
"EmhDateDeceased": null,
"EmhEffectiveDate": null,
"EmpEtimeAccessRoleCode": null,
"EmpMsgId": null,
"EmpPositionCode": null,
"EmpFieldTrackingFlag": "N",
"EmpTd1ProvExempAmt": 0,
"EmpWorkProvince": null,
"EmpPensionNumber": null,
"EmpDisabledFlag": null,
"EmpAboriginalFlag": null,
"EmpVisibleMinorityFlag": null,
"EmpTxtCode": null,
"EmpCreateAccessCode": null,
"EmpDeleteAccessCode": null,
"EmpDeleteFromAprvList": null,
"EmpBenDedEndDate": null,
"EmpSource": null,
"EmpVUuid": "",
"EmpBpFlag": null,
"EmpContractType": null,
"EmpMonthlySalary": null,
"EmpProbationDate": null,
"EmpReligionCode": null,
"EmpSalaryFrq": null,
"EmpSchoolPercent": null,
"EmpAirportCode": null,
"PyenEmiratesId": null,
"PyenLaborCardExpDate": null,
"PyenLaborCardIssueDate": null,
"PyenLaborCardNo": null,
"PyenMotherName": null,
"PyenPassportExpDate": null,
"PyenPassportIssueDate": null,
"PyenPassportNo": null,
"PyenPassportPlaceIssue": null,
"PyenPrimaryNation": null,
"PyenSecondNation": null,
"PyenVUuid": null,
"PyenVisaExpDate": null,
"PyenVisaIssueDate": null,
"PyenVisaNo": null,
"PyenVisaPlaceIssue": null,
"PyenPrevEmpNo": null,
"EmpIePayeExclusionFlag": null,
"EmpIePrsiClassCategory": null,
"EmpIeTaxrelief": null,
"EmpUk1stPayComp": null,
"EmpUk1stPayPeriod": null,
"EmpUk1stPayRun": null,
"EmpUk1stPayYear": null,
"EmpUkEeaCitizenFlag": null,
"EmpUkEpm6Flag": null,
"EmpUkNicCategory": null,
"EmpUkPassportNo": null,
"EmpUkPayeTaxCode": null,
"EmpUkPrvEmplrGrossAmt": null,
"EmpUkPrvEmplrLeaveDate": null,
"EmpUkPrvEmplrOfficeNum": null,
"EmpUkPrvEmplrPayeRef": null,
"EmpUkPrvEmplrTaxAmt": null,
"EmpUkPrvEmplrTaxCode": null,
"EmpUkPrvEmplrWm1Flag": null,
"EmpUkSecondedFlag": null,
"EmpUkSecondedResidence": null,
"EmpUkStarterDeclaration": null,
"EmpUkStudentFlag": null,
"EmpUkTaxFrq": null,
"links": [
{
"rel": "self",
"href": "https://dev6v12.cmic.ca:9999/cmicdevv12/hcm-rest-api/rest/1/pyemployee/",
"name": "pyemployee",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://dev6v12.cmic.ca:9999/cmicdevv12/hcm-rest-api/rest/1/pyemployee/",
"name": "pyemployee",
"kind": "item"
}
]
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"cmicBasicAuth": {
"type": "http",
"scheme": "basic",
"description": "Basic authentication"
}
}
}
}
````