Create a new PY Employee
    • 19 Jun 2024
    • 4 Minutes to read
    • Dark
      Light

    Create a new PY Employee

    • Dark
      Light

    Article summary

    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{ "EmpUser": "DA", "EmpFirstName": "Jimmy", "EmpLastName": "Bond", "EmpSinNo": "123007007", "EmpStatus": "A", "EmpDateOfBirth": "1990-10-10", "EmpHireDate": "2020-09-20", "EmpCompCode": "001", "EmpDeptCode": "00", "EmpPrnCode": "WK", "EmpPygCode": "HRLY", "EmpTrdCode": "CARP", "EmpHourlyRate": 9999.99, "EmpChargeOutRate": 9999.99, "EmpBillingRate": 9999.99, "EmpZipCode": "10004", "EmpCountryCode": "US", "EmpStateCode": "NY", "EmpFilingStatus": "03", "EmpSecGrpEmpCode": "MASTER", "EmpRetiredFlag": "MASTER", "EmpRetirementPension": 1500, "EmpVUuid": "" }
    EmpChargeOutRate
    number Required

    Charge out rate

    💻 UI Fieldname: EmpChargeOutRate

    Max length2216
    EmpBillingRate
    number Required

    Hourly Billing Rate – All Employees

    💻 UI Fieldname: EmpBillingRate

    Max length2216
    EmpCompCode
    string Required

    Payroll Company code

    💻 UI Fieldname: EmpCompCode

    Max length8
    EmpSecGrpEmpCode
    string

    💻 UI Fieldname: EmpSecGrpEmpCode

    Max length200
    EmpStatus
    string Required

    ‘A’- Active ,‘T’- Terminated, ‘D’- Deceased

    💻 UI Fieldname: EmpStatus

    Max length1
    EmpPygCode
    string Required

    Employee Pay Group

    💻 UI Fieldname: EmpPygCode

    Max length4
    EmpPrnCode
    string Required

    Pay Run Code

    💻 UI Fieldname: EmpPrnCode

    Max length4
    EmpSinNo
    string Required

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

    💻 UI Fieldname: EmpSinNo

    Max length16
    EmpTrdCode
    string Required

    Employee Trade Code – must be a valid CMiC Trade Code

    💻 UI Fieldname: EmpTrdCode

    Max length4
    EmpStateCode
    string Required

    Employee State Code

    💻 UI Fieldname: EmpStateCode

    Max length4
    EmpDateOfBirth
    string Required

    Employee date of Birth

    💻 UI Fieldname: EmpDateOfBirth

    EmpVUuid
    string

    💻 UI Fieldname: EmpVUuid

    EmpUser
    string Required

    User who last updated (or imported) this record.

    💻 UI Fieldname: EmpUser

    Max length30
    EmpFirstName
    string Required

    Employee First Name

    💻 UI Fieldname: EmpFirstName

    Max length60
    EmpCountryCode
    string Required

    Employee Country Code – US

    💻 UI Fieldname: EmpCountryCode

    Max length4
    EmpHourlyRate
    number Required

    Hourly Pay Rate – Hourly Employees only.

    💻 UI Fieldname: EmpHourlyRate

    Max length2216
    EmpDeptCode
    string Required

    Payroll Default dept code

    💻 UI Fieldname: EmpDeptCode

    Max length6
    EmpFilingStatus
    string

    Employee Federal Filing Status

    💻 UI Fieldname: EmpFilingStatus

    Max length2
    EmpZipCode
    string Required

    💻 UI Fieldname: EmpZipCode

    Max length13
    EmpLastName
    string Required

    Employee Last Name

    💻 UI Fieldname: EmpLastName

    Max length60
    EmpHireDate
    string Required

    Employee Original Hire date

    💻 UI Fieldname: EmpHireDate

    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
      "EmpNo": "98086",
      "EmpCalcPref": null,
      "EmpComment": null,
      "EmpResLoc": null,
      "EmpOtEligibility": null,
      "EmpPaymentMode": null,
      "EmpLastIncrDate": null,
      "EmpLastPromDate": null,
      "EmpLastTranDate": null,
      "EmpUser": "DA",
      "EmpIuCreateDatetime": null,
      "EmpIuUpdateDatetime": null,
      "EmpTd1ExempAmt": null,
      "EmpEiCode": null,
      "EmpAdpFilingStatus": null,
      "EmpSseFlag": null,
      "EmpTd1ExempFlag": null,
      "EmpEligibilityFlag": null,
      "EmpHardshipSuspFlag": null,
      "EmpSecGrpEmpCode": "MASTER",
      "EmpSecGrpEmpName": null,
      "EmpFlsaType": null,
      "EmpHemplYearlySal": null,
      "EmpHemplType": null,
      "EmpHasCert": null,
      "EmpHasSkill": null,
      "EmpHrrTypeCode": null,
      "EmpHrrTypeDesc": null,
      "EmpLastTshJobCompCode": null,
      "EmpLastTshJobCode": null,
      "EmpLastTshJobDesc": null,
      "EmpWorkCellPhone": null,
      "EmpWorkEmailAddress": null,
      "EmpVertexGeocodeSource": null,
      "EmpAddressForeignFlag": null,
      "EmpPhAddressForeignFlag": null,
      "EmpPhCountryCode": null,
      "EmpPhCountryName": null,
      "EmpPhStateCode": null,
      "EmpPhStateName": null,
      "EmpReportsTo": null,
      "EmpReportsToName": null,
      "EmpFullName": null,
      "EmpFirstName": "Jimmy",
      "EmpMiddleName": null,
      "EmpLastName": "Bond",
      "EmpPrefixName": null,
      "EmpSuffixName": null,
      "EmpNickName": null,
      "EmpSinNo": "123007007",
      "EmpType": null,
      "EmpFullPartTime": null,
      "EmpStatus": "A",
      "EmpStatusDesc": null,
      "EmpSubStatus": null,
      "EmpCalcAccruedLeave": null,
      "EmpUnionized": null,
      "EmpMembershipDate": null,
      "EmpRehireEligible": null,
      "EmpUniCode": null,
      "EmpUniName": null,
      "EmpUnionMemNo": null,
      "EmpJobTitle": null,
      "EmpPlaceOfBirth": null,
      "EmpDateOfBirth": "1990-10-10",
      "EmpHireDate": "2020-09-20",
      "EmpTerminationDate": null,
      "EmpReHireDate": null,
      "EmpDateDeceased": null,
      "EmpSeniorityDate": null,
      "EmpNextReviewDate": null,
      "EmpAdjustedSeriviceDate": null,
      "EmpPrimaryEmpNo": null,
      "EmpYearWorkingDays": null,
      "EmpYearWorkingHours": null,
      "EmpServiceYears": null,
      "EmpUeValidFlag": null,
      "EmpCompCode": "001",
      "EmpCompName": null,
      "EmpHomeCompCode": null,
      "EmpHomeCompName": null,
      "EmpDeptCode": "00",
      "EmpDeptName": null,
      "EmpHomeDeptCode": null,
      "EmpHomeDeptName": null,
      "EmpGlAccCode": null,
      "EmpGlAccName": null,
      "EmpPayrollClearAccCode": null,
      "EmpPayrollClearAccName": null,
      "EmpDrClearAccCode": null,
      "EmpDrClearAccName": null,
      "EmpLevAcruGlAccCode": null,
      "EmpLevAcruGlAccName": null,
      "EmpLevClearAccCode": null,
      "EmpLevClearAccName": null,
      "EmpPrnCode": "WK",
      "EmpPrnName": null,
      "EmpPygCode": "HRLY",
      "EmpPygName": null,
      "EmpWrlCode": null,
      "EmpWrlName": null,
      "EmpGrdCode": null,
      "EmpGrdName": null,
      "EmpTrdCode": "CARP",
      "EmpTrdName": null,
      "EmpExpAprvGrpCode": null,
      "EmpExpAprvGrpName": null,
      "EmpTshCode": null,
      "EmpTshName": null,
      "EmpCklocCode": null,
      "EmpCklocName": null,
      "EmpWcbCode": null,
      "EmpWcbName": null,
      "EmpPlCode": null,
      "EmpPlName": null,
      "EmpWcbByJob": null,
      "EmpPlByJob": null,
      "EmpWrlFlag": null,
      "EmpExcpInclFlag": null,
      "EmpInclCertPyRepFlag": null,
      "EmpAutogenerateTimesheet": null,
      "EmpDispatchFlag": null,
      "EmpAnnualSalary": null,
      "EmpHourlyRate": 9999.99,
      "EmpChargeOutRate": 9999.99,
      "EmpBillingRate": 9999.99,
      "EmpRateCode": null,
      "EmpRateName": null,
      "EmpOtRateCode": null,
      "EmpOtRateName": null,
      "EmpDotRateCode": null,
      "EmpDotRateName": null,
      "EmpOthRateCode": null,
      "EmpOthRateName": null,
      "EmpPreferPayRate": null,
      "EmpPreferChargeRate": null,
      "EmpPreferBillRate": null,
      "EmpDirectDepMethod": null,
      "EmpDirectDepEmail": null,
      "EmpMinHourCode": null,
      "EmpUserEnteredOt": null,
      "EmpUserEnteredDt": null,
      "EmpJobCompCode": null,
      "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": null,
      "EmpZipCode": "10004",
      "EmpPhAddress1": null,
      "EmpPhAddress2": null,
      "EmpPhAddress3": null,
      "EmpPhZipCode": null,
      "EmpCountryCode": "US",
      "EmpCountryName": null,
      "EmpStateCode": "NY",
      "EmpStateName": null,
      "EmpCountyCode": null,
      "EmpCountyName": null,
      "EmpCityCode": null,
      "EmpCityName": null,
      "EmpPhone": null,
      "EmpWorkPhone": null,
      "EmpCellPhone": null,
      "EmpPager": null,
      "EmpFax": null,
      "EmpWorkFax": null,
      "EmpEmailAddress": null,
      "EmpResLatitude": null,
      "EmpResLongitude": null,
      "EmpBpCode": null,
      "EmpPrefContactMth": null,
      "EmpVertexGeocode": null,
      "EmpVertexSchdist": null,
      "EmpResidentStatus": null,
      "EmpFilingStatus": "03",
      "EmpFilingStatusName": null,
      "EmpStateFilingStatus": null,
      "EmpStateFilingStatusName": null,
      "EmpCityFilingStatus": null,
      "EmpCityFilingStatusName": null,
      "EmpPrimExemp": null,
      "EmpSecnExemp": null,
      "EmpTertExemp": null,
      "EmpPrimExempAmt": null,
      "EmpSuplExempAmt": null,
      "EmpSuiState": null,
      "EmpSuiStateName": null,
      "EmpNrCertificate": null,
      "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": null,
      "EmpMaritalStatus": null,
      "EmpEthnicCode": null,
      "EmpMilitaryStatus": null,
      "EmpMilitarySeparationDate": null,
      "EmpDominantHand": null,
      "EmpLeaveCalcPref": null,
      "EmhActionCode": null,
      "EmhDateDeceased": null,
      "EmhEffectiveDate": null,
      "EmpEtimeAccessRoleCode": null,
      "EmpMsgId": null,
      "EmpPositionCode": null,
      "EmpFieldTrackingFlag": null,
      "EmpTd1ProvExempAmt": null,
      "EmpWorkProvince": null,
      "EmpPensionNumber": null,
      "EmpDisabledFlag": null,
      "EmpAboriginalFlag": null,
      "EmpVisibleMinorityFlag": null,
      "EmpTxtCode": null,
      "EmpCreateAccessCode": null,
      "EmpDeleteAccessCode": null,
      "EmpDeleteFromAprvList": null,
      "EmpBenDedEndDate": null,
      "EmpSource": null,
      "EmpVUuid": "F4229554416777DCE05316821FAC5E5F",
      "EmpBpFlag": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyemployee/F4229554416777DCE05316821FAC5E5F",
          "name": "pyemployee",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyemployee/F4229554416777DCE05316821FAC5E5F",
          "name": "pyemployee",
          "kind": "item"
        }
      ]
    }
    object