API Catalog

Create a new PY Employee

27 Feb 2025
21 Minutes to read

Print
Dark
Light

Create a new PY Employee

Updated on 27 Feb 2025
21 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/hcm-rest-api/rest/1/pyemployee

Create Employees

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

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.0, "EmpChargeOutRate": 100.0, "EmpBillingRate": 150.0, "EmpSecGrpEmpCode": "MASTER", "EmpFilingStatus": "02", "EmpVUuid": "", "EmpCountryCode": "US", "EmpStateCode": "OH", "EmpZipCode": "43055", "EmpAddress3": "Newark", "EmpCalcPref": "S", "EmpResLoc": "SNY", "EmpFullName": "Liam Kinder", "EmpFlsaType": "N", "EmpHemplYearlySal": 0.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.0, "EmpYearWorkingHours": 2080.0, "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.0, "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.0, "EmpNrCertificate": "Y", "EmpSex": "M", "EmpMaritalStatus": "S", "EmpEthnicCode": "W", "EmpMilitaryStatus": "NV", "EmpDominantHand": "R", "EmpLeaveCalcPref": "R" }

EmpNo

string Required

Required ONLY when SysPyAutoNumberFlag on SYSOPT is set to 'N' otherwise generated as "EmpCompCode-Sequence". The unique identifier of an employee

💻 UI Fieldname: Employee #

Max length16

EmhActionCode

string Required

NR- New Record, CH - Change, TM - Terminate, IN - Increment, PR - Promotion, DE - Deceased, RR - Re-Hire, TR - Transfer, RT - Retire

💻 UI Fieldname: EmhActionCode

Max length2

EmpFirstName

string Required

Employee First Name

💻 UI Fieldname: First Name

Max length60

EmpLastName

string Required

Employee Last Name

💻 UI Fieldname: Last Name

Max length60

EmpSinNo

string Required

Employee Social Security decimalber (US) or Social Insurance decimalber (CDN). Do not include dashes (-).

💻 UI Fieldname: SSN / SIN

Max length16

EmpDateOfBirth

string Required

Employee date of Birth

💻 UI Fieldname: Date of Birth

EmpHireDate

string Required

Employee Original Hire date

💻 UI Fieldname: Hire Date

EmpCompCode

string Required

Payroll Company code

💻 UI Fieldname: Payroll Company

Max length8

EmpHomeCompCode

string Required

Employee Home Company Code for Inter-Branch costing

💻 UI Fieldname: Home Company

Max length8

EmpDeptCode

string Required

Payroll Default dept code

💻 UI Fieldname: Payroll Dept

Max length6

EmpPrnCode

string Required

Pay Run Code

💻 UI Fieldname: Pay Run

Max length4

EmpPygCode

string Required

Employee Pay Group

💻 UI Fieldname: Pay Group

Max length4

EmpWrlCode

string Required

Identify the Location

💻 UI Fieldname: Work Location

Max length15

EmpTrdCode

string Required

Employee Trade Code – must be a valid CMiC Trade Code

💻 UI Fieldname: Trade

Max length4

EmpWcbCode

string Required

Workers Compensation Code. Required ONLY when ConWcFlag on PYCONTROL is set to 'Y'.

💻 UI Fieldname: WC Code

Max length4

EmpPlCode

string

Public Liability. Required ONLY when ConPlFlag on PYCONTROL is set to 'Y'.

💻 UI Fieldname: PL Code

Max length4

EmpUniCode

string Required

Identify the Union. Required when EmpUnionized is 'Y'.

💻 UI Fieldname: Union Code

Max length4

EmpCklocCode

string

Required ONLY when SysPyUseChklocFlag on SYSOPT is set to 'Y'. Check location code

💻 UI Fieldname: EmpCklocCode

Max length16

EmpType

string

Identify the Type of the employment as H - Hourly, S - Salaried.

💻 UI Fieldname: Type

Max length1

EmpAnnualSalary

number Required

Annual Salary of the employee. Required ONLY when EmpType = 'S' and EmpSalaryFrq will be set to 'A' as default.

💻 UI Fieldname: Annual Salary

Max length18

EmpMonthlySalary

number Required

Salaried Employee Monthly Salary. Required ONLY when EmpType = 'S' and EmpSalaryFrq will be set to 'M' as default.

💻 UI Fieldname: Monthly Salary

EmpHourlyRate

number Required

Hourly Pay Rate – Hourly Employees only. Required ONLY when EmpType = 'H'.

💻 UI Fieldname: Hourly Rate

Max length16

EmpChargeOutRate

number Required

The Rate at which the Job is charged out. Required ONLY when EmpType = 'H'.

💻 UI Fieldname: Charge Out Rate

Max length16

EmpBillingRate

number Required

Rate at which the Billing is done. Required ONLY when EmpType = 'H'. The

💻 UI Fieldname: Billing Rate

Max length16

EmpCountryCode

string Required

Identify the Country. Required ONLY when EmpVertexGeocodeSource = 'M'.

💻 UI Fieldname: Country Code

Max length4

EmpStateCode

string Required

Identify the State / Province. Required ONLY when EmpVertexGeocodeSource = 'M'.

💻 UI Fieldname: State/Province

Max length4

EmpZipCode

string Required

Zip or Postal Code of the Address. Required ONLY when EmpVertexGeocodeSource = 'M'.

💻 UI Fieldname: Zip Code

Max length13

EmpPhCountryCode

string Required

Identify the Physical Address Country. Required ONLY when EmpVertexGeocodeSource = 'P'.

💻 UI Fieldname: Country Code

Max length4

EmpPhStateCode

string Required

Identify the Physical Address State / Province. Required ONLY when EmpVertexGeocodeSource = 'P'.

💻 UI Fieldname: State/Province

Max length4

EmpPhZipCode

string Required

Required ONLY when EmpVertexGeocodeSource = 'P'.

💻 UI Fieldname: Physical Zip Code

Max length13

EmpFilingStatus

string Required

Employee Federal Filing Status. Required ONLY when EmpCountryCode ='US'.

💻 UI Fieldname: Federal Filing Status

Max length2

EmpSeniorityDate

string Required

Date from which employee`s seniority will be considered. Required ONLY when EmpLeaveCalcPref = 'S'.

💻 UI Fieldname: Seniority Date

EmpPrimExemp

number Required

Required ONLY when EmpCountryCode ='US' and ConMandatoryPrmExempFlag on PYCONTROL is set to 'Y'.

💻 UI Fieldname: Primary Exemptions

Max length2

EmpPrimExempAmt

number Required

Required ONLY when EmpCountryCode ='US' and ConMandatoryPrmExempAmtFlag on PYCONTROL is set to 'Y'.

💻 UI Fieldname: Primary Exemptions Amount

Max length18

EmpTd1ExempAmt

number Required

Required ONLY when EmpCountryCode ='CA'.

💻 UI Fieldname: Federal Exemption Amount

Max length18

EmpUkPayeTaxCode

string Required

United Kingdom PAYE tax code. Required ONLY when EmpCountryCode ='UK'.

💻 UI Fieldname: Tax Code

Max length10

EmpVUuid

string Required

Unique uuid of row. Leave it blank when inserting.

💻 UI Fieldname: EmpVUuid

Max length64

EmhEffectiveDate

string

Effective Date from

💻 UI Fieldname: EmhEffectiveDate

EmpTxtCode

string

Reason Code

💻 UI Fieldname: Reason Code

Max length8

EmpPrefixName

string

Employee Prefix Name

💻 UI Fieldname: Prefix

Max length16

EmpSuffixName

string

Employee Suffix Name

💻 UI Fieldname: Suffix

Max length16

EmpMiddleName

string

Employee Middle Name

💻 UI Fieldname: Initial / Middle Name

Max length60

EmpNickName

string

Employee Nick Name

💻 UI Fieldname: Alias

Max length16

EmpFullPartTime

string

F=Full-time, P=Part-time

💻 UI Fieldname: Full / Part

Max length1

EmpStatus

string

A- Active, T- Terminated, D- Deceased

💻 UI Fieldname: Status

Max length1

EmpSubStatus

string

Identify the Working Status

💻 UI Fieldname: Work Status

Max length4

EmpFlsaType

string

Allow user to select employee as E - Exempt or N - Non-Exempt

💻 UI Fieldname: FLSA Type

Max length1

EmpUnionized

string

Identify Employee relation with Union as Y/N

💻 UI Fieldname: Unionized

Max length1

EmpUnionMemNo

string

Union Membership No. if applicable

💻 UI Fieldname: Union Member No.

Max length16

EmpMembershipDate

string

Union Membership Date

💻 UI Fieldname: Union Membership Date

EmpRehireEligible

string

Eligible for Rehire Y/N

💻 UI Fieldname: Eligible for Rehire

Max length1

EmpJobTitle

string

Employee Job Title

💻 UI Fieldname: Job Title

Max length60

EmpPlaceOfBirth

string

Place of Birth of the Employee

💻 UI Fieldname: Place of Birth

Max length30

EmpYearWorkingDays

number

Working days per year

💻 UI Fieldname: Work Days/Year

Max length3

EmpYearWorkingHours

number

Working hours per year

💻 UI Fieldname: Hours/Year

Max length18

EmpTerminationDate

string

Termination Date of the Employee

💻 UI Fieldname: Termination Date

EmpReHireDate

string

Re Hire Date of the employee

💻 UI Fieldname: Re-Hire Date

EmpNextReviewDate

string

Next review date

💻 UI Fieldname: Next Review Date

EmpAdjustedSeriviceDate

string

💻 UI Fieldname: Adjusted Service Date

EmpServiceYears

number

Service years

💻 UI Fieldname: Service/Years

Max length4

EmpHasCert

string

Certifications the employee has

💻 UI Fieldname: EmpHasCert

Max length20

EmpHasSkill

string

Skills the employee has

💻 UI Fieldname: EmpHasSkill

Max length20

EmpCalcAccruedLeave

string

Allow accrued leave Y/N

💻 UI Fieldname: Allow Accrued Leave

Max length1

EmpHomeDeptCode

string

Employee Home Department Code for Inter-Branch costing

💻 UI Fieldname: Home Dept

Max length6

EmpGlAccCode

string

Salary Posting default Account Code

💻 UI Fieldname: Debit Salary Acc

Max length16

EmpPayrollClearAccCode

string

Payroll Clearance default Account Code

💻 UI Fieldname: Credit Clearing Acc

Max length16

EmpDrClearAccCode

string

Payroll CR Clearance default Account Code

💻 UI Fieldname: Debit Clearing Acc

Max length16

EmpLevAcruGlAccCode

string

Leave exp accrual

💻 UI Fieldname: Leave Exp Accrual

Max length16

EmpLevClearAccCode

string

Leave liability accrual

💻 UI Fieldname: Leave Liability Accrual

Max length16

EmpTshCode

string

E-Timesheet code

💻 UI Fieldname: E-Time

Max length4

EmpSecGrpEmpCode

string

Required when user has no default Security Group.

💻 UI Fieldname: Default Security Group

Max length200

EmpGrdCode

string

Grade Code

💻 UI Fieldname: Grade

Max length4

EmpSchoolPercent

number

School Eligibility Percentage

💻 UI Fieldname: School Percent

EmpExpAprvGrpCode

string

Exp Approve Group Code

💻 UI Fieldname: Exp Appr Group

Max length8

EmpWcbByJob

string

WCB by Job Yes/No

💻 UI Fieldname: Workers Comp from Job

Max length1

EmpPlByJob

string

WCB by Job Yes/No

💻 UI Fieldname: Public Liability from Job

Max length1

EmpWrlFlag

string

Work location for Job

💻 UI Fieldname: Work Location for Job

Max length1

EmpExcpInclFlag

string

Include in exception report Y/N

💻 UI Fieldname: Include in Exception Report

Max length1

EmpInclCertPyRepFlag

string

Include into Certified Payroll Report Y/N

💻 UI Fieldname: Include into Certified Payroll Report

Max length1

EmpAutogenerateTimesheet

string

Include in Generate Timesheet Utility Y/N

💻 UI Fieldname: Include in Generate Timesheet Utility

Max length1

EmpFieldTrackingFlag

string

Identity An Employee Is Available In The Field Tracking Screen. Y/N

💻 UI Fieldname: Include In Field Tracking

Max length1

EmpDispatchFlag

string

For new records in DA.PYEMPLOYEE_TABLE defaults value from Dispatch_flag of DA.PYPAYPRD. Y/N

💻 UI Fieldname: Available For Dispatch

Max length1

EmpRateCode

string

Identify the Rate Code for Normal Working Hours

💻 UI Fieldname: NWHR Rate

Max length4

EmpOtRateCode

string

Identify the Rate Code for OT working hours

💻 UI Fieldname: OT Rate

Max length4

EmpDotRateCode

string

Identify the Rate Code for DOT working hours

💻 UI Fieldname: DOT Rate

Max length4

EmpOthRateCode

string

Identify the Rate Code for OTH working hours

💻 UI Fieldname: OTH Rate

Max length4

EmpSalaryFrq

string

Salaried Employee Frequency Salary

💻 UI Fieldname: Salary Frq

Max length1

EmpPreferPayRate

string

Preffered Pay Rate for Employee J - Job, U - Union, E - Employee, C - Customer, T - Trade, 'B', 'R','P'

💻 UI Fieldname: Preferred Pay Rate

Max length1

EmpPreferChargeRate

string

Preffered Pay Rate for Employee J - Job, U - Union, E - Employee, C - Customer, T - Trade, 'B', 'R','P'

💻 UI Fieldname: Preferred Charge Out Rate

Max length1

EmpPreferBillRate

string

Preffered Pay Rate for Employee J - Job, U - Union, E - Employee, C - Customer, T - Trade, 'B', 'R','P'

💻 UI Fieldname: Preferred Bill Rate

Max length1

EmpDirectDepMethod

string

Preferred Method For Receiving Direct Deposit Stubs: M-Mail, E-Email, N-None

💻 UI Fieldname: Preferred Method for Direct Deposit Stubs

Max length1

EmpDirectDepEmail

string

Email Address For Direct Deposit Stubs

💻 UI Fieldname: Direct Deposit Email

Max length100

EmpMinHourCode

string

Optional minimum hours code for E-time. References table PYMINHR.

💻 UI Fieldname: Minimum Hour Code

Max length10

EmpUserEnteredOt

string

Entered Overtime Y/N

💻 UI Fieldname: Entered Overtime

Max length1

EmpUserEnteredDt

string

Entered Double Overtime Y/N

💻 UI Fieldname: Entered Double Overtime

Max length1

EmpJobCompCode

string

Job Company Code

💻 UI Fieldname: Company

Max length8

EmpJobCode

string

Job Code

💻 UI Fieldname: Job

Max length10

EmpPhsCode

string

Phase Code

💻 UI Fieldname: Cost Code

Max length16

EmpCatCode

string

Default Job Category Code

💻 UI Fieldname: Category

Max length16

EmpEquipmentNo

string

Equipment Number

💻 UI Fieldname: Equipment

Max length10

EmpEquipPhsCode

string

Default job phase code for the piece of equipment

💻 UI Fieldname: Cost Code

Max length16

EmpEquipCategory

string

Equipment Category Code

💻 UI Fieldname: Category

Max length16

EmpEquipTranCode

string

Equipment Tran Code

💻 UI Fieldname: Tran Code

Max length4

EmpVertexGeocodeSource

string

Identify Address To Populate Employee Vertext Geocode Valid Values M=Mailing Address; P=Physical Address

💻 UI Fieldname: Geo Code From

Max length1

EmpAddressForeignFlag

string

Flag Decides Employee Mailing Address Is Foreign Address Or Not?

💻 UI Fieldname: Foreign Address

Max length1

EmpAddress1

string

Home Address of the Employee

💻 UI Fieldname: EmpAddress1

Max length30

EmpAddress2

string

Home Address of the Employee

💻 UI Fieldname: EmpAddress2

Max length30

EmpAddress3

string

Home Address of the Employee

💻 UI Fieldname: EmpAddress3

Max length30

EmpPhAddressForeignFlag

string

Flag Decides Employee Physical Address Is Foreign Address Or Not?

💻 UI Fieldname: Foreign Address

Max length1

EmpPhAddress1

string

Physical Home Address of the Employee

💻 UI Fieldname: EmpPhAddress1

Max length30

EmpPhAddress2

string

Physical Home Address of the Employee

💻 UI Fieldname: EmpPhAddress2

Max length30

EmpPhAddress3

string

Physical Home Address of the Employee

💻 UI Fieldname: EmpPhAddress3

Max length30

EmpCountyCode

string

Identify the County

💻 UI Fieldname: County/Region

Max length4

EmpCityCode

string

Identify the City / Town

💻 UI Fieldname: City/Town

Max length4

EmpPhone

string

Home Phone Number of the Employee

💻 UI Fieldname: Home Phone

Max length16

EmpWorkPhone

string

Work Phone Number

💻 UI Fieldname: Work Phone

Max length24

EmpFax

string

Home Fax Number of the Employee

💻 UI Fieldname: Home Fax

Max length16

EmpWorkFax

string

Work Fax Number

💻 UI Fieldname: Work Fax

Max length24

EmpCellPhone

string

Cell Phone Number

💻 UI Fieldname: Cell Phone

Max length24

EmpWorkCellPhone

string

Employee Work Cell Phone

💻 UI Fieldname: Work Cell Phone

Max length24

EmpEmailAddress

string

Email Address

💻 UI Fieldname: Email Address

Max length100

EmpWorkEmailAddress

string

Employee Work Email Address

💻 UI Fieldname: Work Email Address

Max length100

EmpPager

string

Pager Number

💻 UI Fieldname: Pager

Max length24

EmpResLatitude

string

Latitude of Location

💻 UI Fieldname: Latitude

Max length16

EmpResLongitude

string

Longitude of Location

💻 UI Fieldname: Longitude

Max length16

EmpPrimaryEmpNo

string

Main employee that this employee is linked to and duplicated from.

💻 UI Fieldname: Primary Employee

Max length16

EmpBpCode

string

Business Partner and Vendor Code Created For Employee

💻 UI Fieldname: Business Partner Code

Max length8

EmpBpFlag

string

BP Flag Y/N

💻 UI Fieldname: EmpBpFlag

Max length1

EmpPrefContactMth

string

Preferred Method For Sending AP Direct Deposit Stubs For Employee. E - Email, M - Mail

💻 UI Fieldname: AP EFT Distribution Method

Max length30

EmpPensionNumber

string

Pension registration number of the union to which the employee belongs

💻 UI Fieldname: Pension Number

Max length7

EmpProbationDate

string

Employee Probation End Date

💻 UI Fieldname: Probation Date

EmpVertexGeocode

string

Vertex Geo Code

💻 UI Fieldname: Geo Code

Max length5

EmpVertexSchdist

number

Vertex School District Code

💻 UI Fieldname: School District Code

Max length5

EmpResidentStatus

string

Residential Status of the Employee. C - Citizen, I - Immigrant, R - Refugee, W - Work Permit, F - F1 Visa

💻 UI Fieldname: Residential Status

Max length1

EmpStateFilingStatus

string

State Filing Status

💻 UI Fieldname: State Filing Status

Max length2

EmpCityFilingStatus

string

City Filing Status

💻 UI Fieldname: City Filing Status

Max length2

EmpSecnExemp

number

Secondary Exemptions

💻 UI Fieldname: Secondary Exemptions

Max length2

EmpEiCode

string

EI Code

💻 UI Fieldname: Ei Code

Max length4

EmpTertExemp

number

Tert Exemptions

💻 UI Fieldname: Tert Exemp

Max length2

EmpSuplExempAmt

number

Supple Exemption Amount

💻 UI Fieldname: Suppl Exemption Amount

Max length18

EmpSuiState

string

SUI/SDI Location

💻 UI Fieldname: SUI/SDI Location

Max length15

EmpNrCertificate

string

Non-Residence Certificate Y/N

💻 UI Fieldname: Non-Residence Certificate

Max length1

EmpPensionFlag

string

Y/N

💻 UI Fieldname: Pension

Max length1

EmpDefCompFlag

string

Y/N

💻 UI Fieldname: Deferred Compensation

Max length1

EmpWorkProvince

string

Work Province

💻 UI Fieldname: Work Province

Max length4

EmpTd1ExempFlag

string

TD1 Exemption flag for employee

💻 UI Fieldname: Td1 Exemp Fla

Max length1

EmpTd1ProvExempAmt

number

TD1 Prov exemption amount

💻 UI Fieldname: Td1 Prov Exemp Amt

Max length18

EmpUkNicCategory

string

United Kingdom NIC category code

💻 UI Fieldname: NIC Category

Max length1

EmpUkTaxFrq

string

Tax Frequency

💻 UI Fieldname: Tax Frequency

Max length10

EmpUk1stPayComp

string

United Kingdom: New starter first payment company code.

💻 UI Fieldname: Company

Max length8

EmpUk1stPayRun

string

United Kingdom: New starter first payment pay run code.

💻 UI Fieldname: Pay Run

Max length4

EmpUk1stPayYear

number

United Kingdom: New starter first payment year.

💻 UI Fieldname: Year

Max length4

EmpUk1stPayPeriod

number

United Kingdom: New starter first payment period.

💻 UI Fieldname: Period

Max length2

EmpUkStarterDeclaration

string

United Kingdom: New starter declaration: A=First Job This Year, B=Only Job, C=Have Another Job

💻 UI Fieldname: Emp. Declaration

Max length1

EmpUkPassportNo

string

United Kingdom: Passport number

💻 UI Fieldname: Passport No.

Max length35

EmpUkStudentFlag

string

United Kingdom: Student flag (Y/N/null)

💻 UI Fieldname: Student

Max length1

EmpUkPrvEmplrOfficeNum

string

United Kingdom: Previous employer HMRC office number

💻 UI Fieldname: Tax Reference

Max length3

EmpUkPrvEmplrPayeRef

string

United Kingdom: Previous employer PAYE reference number

💻 UI Fieldname: EmpUkPrvEmplrPayeRef

Max length10

EmpUkPrvEmplrLeaveDate

string

United Kingdom: Previous employer leaving date

💻 UI Fieldname: Leaving Date

EmpUkPrvEmplrTaxCode

string

United Kingdom: Previous employer PAYE tax code

💻 UI Fieldname: Tax Code

Max length10

EmpUkPrvEmplrWm1Flag

string

United Kingdom: Previous employer W1/M1 flag (Y/N/null)

💻 UI Fieldname: EmpUkPrvEmplrWm1Flag

Max length1

EmpUkPrvEmplrGrossAmt

number

United Kingdom: Previous employer gross income for new starter year

💻 UI Fieldname: Previous Gross

Max length18

EmpUkPrvEmplrTaxAmt

number

United Kingdom: Previous employer income tax deducted for new starter year

💻 UI Fieldname: Previous Tax

Max length18

EmpUkSecondedFlag

string

United Kingdom: Seconded employee (Y/N/null)

💻 UI Fieldname: Seconded

Max length1

EmpUkEeaCitizenFlag

string

United Kingdom: Seconded employee is a European Economic Area Citizen (Y/N/null)

💻 UI Fieldname: European Economic Area

Max length1

EmpUkEpm6Flag

string

United Kingdom: Seconded employee falls under EPM6 Modified Scheme (Y/N/null)

💻 UI Fieldname: EMP6 (Modified) Schedule

Max length1

EmpUkSecondedResidence

string

United Kingdom: Seconded employee residence: A=UK Over 6 Months, B=UK Under 6 Months, C=Abroad

💻 UI Fieldname: Residence

Max length1

EmpIePayeExclusionFlag

string

Ireland: PAYE exclusion order flag (Y/N/null).

💻 UI Fieldname: EmpIePayeExclusionFlag

Max length1

EmpIePrsiClassCategory

string

Ireland: Employee PRSI class (A,J,K,M) or class modifier (EJS,CES).

💻 UI Fieldname: EmpIePrsiClassCategory

Max length4

EmpIeTaxrelief

number

Employee Taxrelief, it is only for ireland and it is not available in History

💻 UI Fieldname: EmpIeTaxrelief

EmpAddrCompCode

string

Identify the Company

💻 UI Fieldname: Addr. Company

Max length8

EmpAddrCode

string

Identify the Side Address Code

💻 UI Fieldname: Site Address

Max length8

EmpLoginUser

string

System User

💻 UI Fieldname: System User

Max length30

EmpRegionCode

string

Identify the Region

💻 UI Fieldname: Region

Max length8

EmpDisabilityDisCode

string

Disabilities

💻 UI Fieldname: Disability

Max length10

EmpTravelFlag

string

Ability to travle Y/N

💻 UI Fieldname: Able to Travel

Max length1

EmpTravelDistance

number

Maximum mileage/kilometer to travel

💻 UI Fieldname: Distance

Max length11

EmpContractType

string

Employee Contract type S - Single, M - Married, F - Family

💻 UI Fieldname: Contract Type

Max length1

EmpSex

string

Sex of the Employee. M - Male, F - Female, N - Not Known

💻 UI Fieldname: Sex

Max length1

EmpMilitaryStatus

string

NV - Not Veteran, VE - Veteran, DV - Disabled Veteran, SV - Special Disabled Veteran, VV - Vietnam Veteran, MV - Service & Medal Veteran, OV - Active Duty Wartime or Campaign Badge Veteran, PV - Newly Separated Vetaran, IR - Inactive Reserve, RR - Ready Reserve, HV - Disability / Handicap, NS - I do not wish to self-identify. Can have multiple codes separated by commas "VE,OV".

💻 UI Fieldname: EmpMilitaryStatus

Max length20

EmpMilitarySeparationDate

string

Military separation/discharge date. For veterans, field used to determine if "newly separated" for Vet-100 reporting.

💻 UI Fieldname: Military Separation Date

EmpMaritalStatus

string

Marital Status of the Employee. S - Single, M - Married, W - Widowed, D - Divorced, C - Common Law, P - Separated, O - Domestic Partnership

💻 UI Fieldname: Marital Status

Max length1

EmpEthnicCode

string

W - White, B - Black/African American, H - Hispanic/Latino , A - Asian, P - Native Hawaiian/Pacific Islander, I - American Indian/Alaskan Native, M - Two or more races, X - N/A

💻 UI Fieldname: Ethnic Code

Max length2

EmpVisibleMinorityFlag

string

W - Not a Minority, B - Black, E - East/Southeast Asian, S - South Asian, N - Native Peoples, O - Minority-Other, A - No Survey Completed, D - Declined to Answer, X - Minority-No Race Specified

💻 UI Fieldname: Visible Minority

Max length1

EmpDisabledFlag

string

Employee with any kind of disability. Y/N

💻 UI Fieldname: Disabled Flag

Max length1

EmpAboriginalFlag

string

Employee's Aboriginal Status. S - Status, Y - Non-Status, N - Not an Aboriginal

💻 UI Fieldname: Aboriginal Flag

Max length1

EmpReligionCode

string

Employee Religion Code

💻 UI Fieldname: Religion Code

Max length30

EmpDominantHand

string

'R', 'B', 'L', 'N'

💻 UI Fieldname: Dominant Hand

Max length1

EmpLanguageLangName

string

Preferred Language

💻 UI Fieldname: Preferred Lang

EmpHemplYearlySal

number

Hourly Employee Yearly Salary

💻 UI Fieldname: Yearly Salary

Max length18

EmpHemplType

string

H - Hourly, F - Full-Time, S - Salaried, L - Local, N - N/A

💻 UI Fieldname: Benefit Type

Max length10

EmpLeaveCalcPref

string

S - Seniority Date, H - Hire Date, R - Rehire Date, A - Adjusted Service Date

💻 UI Fieldname: Calculate Accrued Leave From

Max length1

EmpCalcPref

string

S - Seniority Date, H - Hire Date, R - Rehire Date, A - Adjusted Service Date

💻 UI Fieldname: Calculate Burdens From

Max length1

EmpLastTshJobCompCode

string

Last Timesheet Job Comp Code

💻 UI Fieldname: Last Timesheet Job Comp Code

Max length8

EmpLastTshJobCode

string

Last Timesheet Job

💻 UI Fieldname: Last Timesheet Job

Max length10

EmpAirportCode

string

Airport Code

💻 UI Fieldname: Airport Code

Max length30

EmpApplicantAplNo

string

Evaluated As

💻 UI Fieldname: Evaluated As

Max length16

EmpHrrTypeCode

string

Identify the Requisition Type

💻 UI Fieldname: Requisition Type

Max length10

EmpPosCode

string

Identify HCM Job Classification

💻 UI Fieldname: Job Classification

Max length10

EmpPositionCode

string

HCM Position Occupied By The Employee

💻 UI Fieldname: Position Code

Max length10

EmpReportsTo

string

Identify The Employee "Reports To" (Direct Manager)

💻 UI Fieldname: Direct Report To

Max length16

EmpComment

string

Comment

💻 UI Fieldname: Comment

Max length2000

PyenVUuid

string

Nationality Unique ID

💻 UI Fieldname: PyenVUuid

Max length64

PyenMotherName

string

Employee Mother's Name

💻 UI Fieldname: Employee Mother's Name

Max length200

PyenPrimaryNation

string

Employee Primary Nationality

💻 UI Fieldname: Employee Primary Nationality

Max length4

PyenSecondNation

string

Employee Secondary Nationality

💻 UI Fieldname: Employee Secondary Nationality

Max length4

PyenPassportPlaceIssue

string

Passport Place of Issue

💻 UI Fieldname: Passport Place of Issue

Max length200

PyenPassportNo

string

Passport Number

💻 UI Fieldname: Passport No

Max length60

PyenPassportIssueDate

string

Passport Date of Issue

💻 UI Fieldname: Passport Date of Issue

PyenPassportExpDate

string

Passport Expiry Date

💻 UI Fieldname: Passport Expiry Date

PyenEmiratesId

string

Employee Emirates ID

💻 UI Fieldname: Employee Emirates ID

Max length20

PyenVisaPlaceIssue

string

Visa Place of Issue

💻 UI Fieldname: Visa Place of Issue

Max length200

PyenVisaNo

string

Employee Visa No

💻 UI Fieldname: Employee Visa No

Max length60

PyenVisaIssueDate

string

Visa Issue Date

💻 UI Fieldname: Visa Issue Date

PyenVisaExpDate

string

Visa Expiry Date

💻 UI Fieldname: Visa Expiry Date

PyenLaborCardNo

string

Labor Card No

💻 UI Fieldname: Labor Card No

Max length60

PyenLaborCardIssueDate

string

Labor Card Issue Date

💻 UI Fieldname: Labor Card Issue Date

PyenLaborCardExpDate

string

Labor Card Expiry Date

💻 UI Fieldname: Labor Card Expiry Date

PyenPrevEmpNo

string

Previous Employee Number

💻 UI Fieldname: Previous Employee Number

Max length16

EmpLastUpdDate

string

Date and Time stamp of the last update

💻 UI Fieldname: Last Upd Date

EmpResLoc

string

Identify the Location

💻 UI Fieldname: Res Loc

Max length15

EmpOtEligibility

string

Employee OT Eligibility

💻 UI Fieldname: Ot Eligibilit

Max length1

EmpPaymentMode

string

Payment Mode like C for Cash

💻 UI Fieldname: Payment Mode

Max length1

EmpUeValidFlag

string

Valid Y/N

💻 UI Fieldname: Valid

Max length1

EmpAdpFilingStatus

string

Adp Filing Status

💻 UI Fieldname: Adp Filing St

Max length1

EmpSseFlag

string

Flag that shows if employee has access to employee selfservice programs

💻 UI Fieldname: Sse Flag

Max length1

EmpEligibilityFlag

string

Eligibility Flag Y/N

💻 UI Fieldname: Eligibility Flag

Max length1

EmpHardshipSuspFlag

string

Identify whether Employee is on on Hardship Suspension

💻 UI Fieldname: Hardship Suspension Flag

Max length1

EmpRegCompCode

string

Identify the Company Region

💻 UI Fieldname: Region

Max length8

EmpCreateAccessCode

string

Create Access Code for new employee Y/N

💻 UI Fieldname: EmpCreateAccessCode

Max length1

EmpDeleteAccessCode

string

Delete Access Code Y/N

💻 UI Fieldname: EmpDeleteAccessCode

Max length1

EmpEtimeAccessRoleCode

string

Etime Access Role Code

💻 UI Fieldname: EmpEtimeAccessRoleCode

Max length10

EmpDeleteFromAprvList

string

Delete from Approve List

💻 UI Fieldname: EmpDeleteFromAprvList

Max length1

Responses

201

Created

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

{
  "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"
    }
  ]
}

object

What's Next

Retrieve PY Employees By Code

Create a new PY Employee

Create Employees

What's Next

Contact Us