Create a PY Employee Pay History
    • 25 Sep 2024
    • 8 Minutes to read
    • Dark
      Light

    Create a PY Employee Pay History

    • Dark
      Light

    Article summary

    Post
    /hcm-rest-api/rest/1/pyemppayhist

    Create Employee Pay History

    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "PhyCompCode": "001", "PhyEmpNo": "04538", "PhyPrnCode": "WK", "PhyPprPeriod": 1.0, "PhyPprYear": 2015.0, "PhySeqNo": 365440.0, "PhyPayDate": "2015-01-07T00:00:00-05:00", "PhyLastUpdDate": "2015-05-22T17:40:46-04:00", "PhyTranCode": "NWHR", "PhyUser": "BILL", "PhyTranType": "BW", "PhyVUuid": "" }
    PhyCompCode
    string Required
    PhyPrnCode
    string Required

    Identify the Pay Run Code

    PhyPprYear
    number Required

    Identify the Year related to the Pay

    PhyPprPeriod
    number Required

    Indentify the Pay Period

    PhyPprSubPeriod
    number

    Indentify the Sub Pay Period

    PhyEmpNo
    string Required

    The unique identifier of an employee

    PhySeqNo
    number Required

    The system generated Sequence Number per Employee per Pay Period

    PhyDate
    date

    The Date from Employee worked during current Pay Period

    PhyEqpDeptCode
    string
    PhyEmpDeptCode
    string
    PhyEmpCrAccCode
    string
    PhyEqpCrAccCode
    string
    PhyWorkCompCode
    string

    The Company for whom Employee worked during transaction period

    PhyDataType
    string

    The type of Line that is entered. Either G" or J

    PhyDeptCode
    string

    The working Department of the Employee

    PhyEmplrContrAccCode
    string

    The respected GL A/C Code for posting of calculated amount to GL

    PhyGlAccCode
    string

    The respected GL A/C Code for posting of calculated amount to GL

    PhyJob
    string

    The Job Code assigned to the Employee

    PhyPhase
    string

    The Job Phase on which the Employee worked

    PhyCategory
    string

    The Job Category on which employee worked

    PhyEquipment
    string

    The respected Equipment Number

    PhyEquipCategory
    string

    The Equipment Category if applicable

    PhyEquipTranNo
    string

    The Equipment Transaction Number if applicable

    PhyHrlyEquipRate
    number

    The Rate applied to calculate the cost for a piece of equipment

    PhyUnionCode
    string

    The Union Code for whom the Employee worked durint Transaction pe

    PhyTradeCode
    string

    The Trade Code being used during calculation

    PhyWorkLocation
    string

    The Work Location of Employee for the calculated Transaction

    PhyTranType
    string Required

    The predefined Type to identify the type of Transaction like "BN"

    PhyTranCode
    string Required

    The respected Code for which the calculations are made

    PhyTranDesc
    string
    PhyTranShortDesc
    string
    PhyQuantity
    number

    The Quantity used for Amount calculation if applicable

    PhyHrsWorked
    number

    The Quantity used for Amount calculation if applicable

    PhyHrsPaid
    number

    The Rate applied to calculate the Amount for a Coe and its Type

    PhyPayRate
    number

    The Rate applied to calculate the Amount for a Coe and its Type

    PhyChargeOutRate
    number

    The Rate applied to calculate the Amount for a Coe and its Type

    PhyBillingRate
    number

    The Rate applied to calculate the Amount for a Coe and its Type

    PhyRateCode
    string
    PhyEmplrContr
    number

    The calculated Amount against the Code and its respective Type

    PhyAmount
    number

    The calculated Amount against the Code and its respective Type

    PhyPayAmount
    number

    The calculated Amount against the Code and its respective Type

    PhyEquipmentCost
    number

    The calculated Amount against the Code and its respective Type

    PhyGrossEarning
    number

    The calculated Amount against the Code and its respective Type

    PhyEmplrContrFlag
    string
    PhyAdjustment
    string
    PhyBatchNum
    number

    The Batch Number referencing to the GL

    PhyProcessFlag
    string
    PhyChequeSeqNumber
    number
    PhyChequeVoidDate
    date
    PhyHireFlag
    string
    PhyTaxtypeFlag
    string
    PhyRetpayFlag
    string
    PhyActivateSeq
    number

    Used to join to PYEMPSALADJ, PYEMPTIMSHT, PYEMPEXPSHTto decide which tables process flag to nullify in CHECK VOIDING.

    PhyPostDate
    date

    The Date the data was posted

    PhyUser
    string Required

    The name of the user who made the last update

    PhyLastUpdDate
    date Required

    Date and Time stamp of the last update

    PhyGlpostFlag
    string
    PhyDrDeptCode
    string
    PhyEmplrContrDeptCode
    string
    PhyUpdateBchFlag
    string
    PhyChargeOutAmt
    number

    Charge Out Amount

    PhyBillingAmt
    number

    Bill Amount

    PhyWoCode
    string

    Work Order Code.

    PhyWitmLineNumber
    string

    Work Item Number.

    PhyWoExpCode
    string

    Work Order Expense Code

    PhyTavCode1
    string
    PhyTavCode2
    string
    PhyTavCode3
    string
    PhyTavCode4
    string
    PhyWbsvCode1
    string
    PhyWbsvCode2
    string
    PhyWbsvCode3
    string
    PhyWbsvCode4
    string
    PhyRedistributedBurdenFlag
    string
    PhyTshAfterChksFlag
    string
    PhyRetainTransactions
    string

    Flag to indicate whether input transactions were retained after checks were voided

    PhyWorkGeocode
    string

    Employee`s work location GeoCode.

    PhyResidenceGeocode
    string

    Employee`s residence location GeoCode.

    PhyPayDate
    date

    Pay date sets on table PYCOMPAYPRD as PPR_PAY_DATE.

    PhyExpectedPostDate
    date

    Expected post date, sets on table PYCOMPPAYPRD as PPR_POSTING_DATE.

    PhyMonthNumber
    number

    Month Number.

    PhyActualPeriod
    number
    PhyOriginalTransaction
    string

    Flag to indicate whether this transaction was the actual transaction which was adjusted during redistribution of costs. (Y)es or (N)o

    PhyRefDate
    date

    Date referrening to Period from which wages and burdens were redistributed

    PhyRefDesc
    string

    Description referrening to Period from which wages and burdens were redistributed

    PhyMasterSeq
    number

    Sequence number to identify the original job from which the cost was transferred

    PhyDetailSeq
    number

    Sequence number to identify the job to which the cost was transferred

    PhyManualChkProc
    string
    PhyManualChkCrAccCode
    string
    PhyPlanCode
    string

    Plan Code For The Transacation. Applicable Only To Benefits And Deductions.

    PhyPloCode
    string

    The Option Against The Plan For The Transaction. Applicable Only To Benefits And Deductions.

    PhyWcbCode
    string
    PhyReceivableFlag
    string

    Flag to indicate whether the transaction originated from a receivable - (Y)es, (R)eturned i.e. extra amount was received and the extra amount was returned back

    PhyUiFromMidyearForm
    string
    PhyEmpType
    string
    PhyEmpPygCode
    string
    PhyExpClaimFlag
    string

    Flag to mention, expense has been entered from expense claim entry.

    PhyVendor
    string
    PhyComment
    string
    PhyApvoucherCreatedFlag
    string
    PhyUserTypeCode
    string
    PhyWoTranType
    string
    PhyCreateGlFlag
    string

    Flag to indicate whether the transaction originated from a loan receivable - G is for with GL entried, W is for without GL, N is normal adjustment and R is returned if an excess amount was paid against loan.

    PhyPlCode
    string

    Public Liability Code.

    PhyWcbPolicyNo
    string
    PhyPlcPolicyNo
    string
    PhyActualPayDate
    date

    Pay date when checks have been printed. For void check reverse transactions, it is the check void date (ie. void effective date).

    PhyEquipPhsCode
    string

    Job phase code for the piece of equipment. It can be different from the phase to which time is being charged.

    PhyEqpHours
    number

    Field to enter Equipment Hours.

    PhyEqpChargeRate
    number

    Field to enter equipment charge rate

    PhyEqpBillRate
    number

    Field to enter equipment bill rate

    PhyEqpChargeAmt
    number

    Field to enter equipment charge amt

    PhyEqpBillAmt
    number

    Field to enter equipment bill amt

    PhyEqpHrlyWmCode
    string

    Field to enter wm code for equipment.

    PhyEqpJccatCode
    string

    Field to enter Equipment Job category.

    PhyTaxCode1
    string
    PhyTaxPercent1
    number
    PhyTaxAmt1
    number
    PhyTaxCode2
    string
    PhyTaxPercent2
    number
    PhyTaxAmt2
    number
    PhyTaxCode3
    string
    PhyTaxPercent3
    number
    PhyTaxAmt3
    number
    PhyTotalTaxCreditAmt
    number
    PhyExpStartDate
    date

    Actual Start Date For Expense Entered From E-Expense. Automatically Populated By E-Expense When Expense Approved

    PhyExpEndDate
    date

    Actual End Date For Expense Entered From E-Expense. Automatically Populated By E-Expense When Expense Approved

    PhySuiWrlCode
    string

    Feild to populate the SUI work location from employee profile

    PhyPostDateChangeDate
    date
    PhyChgPayrateForJobTsh
    string
    PhyAssignedCheckNum
    number
    PhyPrintCheckOnly
    string
    PhyClearingDbAccCode
    string

    Payroll Salary Debit account code setup on employee profile. It will be populate at the time of timesheet posting

    PhyClearingDbDeptCode
    string

    Payroll Salary Debit department code setup on employee profile. It will be populate at the time of timesheet posting

    PhyRedistRecalWcpl
    string

    Transfer labor costs WC/PL recalculate flag ie. column pyredistribute_batch_emp.rbe_recal_wcpl

    PhyEmpEiCode
    string
    PhyShiftCode
    string

    Shift code. Null means unspecified, or D/E/N for Day/Evening/Night shift.

    PhyCklocCode
    string

    Check location code

    PhyVendorAddCode
    string
    PhyVoidckReversalFlag
    string

    Y/null. Y indicates a reversal transaction created by the void check program.

    PhyActualPayDateFixFlag
    string

    Correct NULL PHY_ACTUAL_PAY_DATE for paid transactions from payroll 2006 onwards; and subsequently by trigger. See version script 0789197.sql.

    PhyPrevailingWageRate
    number

    Prevailing wage rate.

    PhyCalculatedEarnings
    number
    PhyFedJurisdiction
    string

    Federal Reporting Jurisdiction: null=not yet determined, *=proper US/CA, GU=Guam,...,see PYFEDTERR.

    PhyRefCheckNum
    number

    This is the Reference Check Number

    PhyActualWorkDate
    date

    This is the Actual Date that Employee Worked on

    PhyStdUnionPayRate
    number

    Employee normal base union pay rate.

    PhyDocumentNo
    string

    Crew Code

    PhyInclCertPyRepFlag
    string

    N: Record will be excluded from the Certified Payroll Report

    PhyRatecdMultiplier
    number

    Rate code multiplier from table column Pypayrcd.rcd_prem_multiplier.

    PhyRatecdHrlyPrem
    number

    Rate code premium per hour from table column Pypayrcd.rcd_prem_per_hour_amt.

    PhyPwBasePayRate
    number

    Base pay rate to use in determining prevailing wage rate differential. Currently equivalent to phy_pay_rate less the hourly premium and multiplier.

    PhyPwFringePayrollRate
    number

    Prevailing wage job-trade calculated payroll fringe rate (per hr worked).

    PhyPwFringeContractRate
    number

    Prevailing wage job-trade contract fringe rate (per hr worked).

    PhyPwFringeOtPremFlag
    string

    Apply overtime premium on contract fringe rate (Y/N/null).

    PhyPwDiffRate
    number

    Calculated prevailing wage differential rate.

    PhyPwDiffAmount
    number

    Calculated prevailing wage differential amount.

    PhyPwDiffDestBen
    string

    Calculated prevailing wage differential destination benefit code.

    PhyPwDiffCalcDone
    string

    Prevailing wage differential calculation done (Y/null). Y also indicates that this BW/LE line is a prevailing wage job-trade.

    PhyPwDifferentialBenFlag
    string

    Y/null: Indicates whether this benefit (BN) line contains the prevailing wage differential.

    PhyPwCompCode
    string

    Prevailing wage job company for Mechanics/Truckers who work on equipments or deliver materials to a PW job but whose labor is costed against the equipment/trucking job.

    PhyPwJobCode
    string

    Prevailing wage job code for Mechanics/Truckers who work on equipments or deliver materials to a PW job but whose labor is costed against the equipment/trucking job.

    PhyEquipLocCode
    string

    Equipment location code.

    PhyCostPoolJob
    string

    Job code for cost pooling burdens. Blank if not applicable.

    PhyActualWcbCode
    string
    PhyHomeCompCode
    string

    Employee Home company at the time of processing payroll

    PhyHomeDeptCode
    string

    Employee Home department at the time of processing payroll

    PhyLeaveTakenTmshtYear
    number

    Store The Leave Taken Year Based On The Timesheet Date

    PhyLevCalcDate
    date

    Employee Leave Calculation Period Start Date

    PhyLevCalcMethod
    string

    Employee Leave Calculation Method

    PhyActualPlCode
    string
    PhyUkPayeTaxCode
    string

    United Kingdom PAYE tax code

    PhyUkNicCategory
    string

    United Kingdom NIC category code

    PhyVertexPsdcode
    number

    Vertex Employee Resident PSD Codes Based On The Vertex Geocode And School District Code Of The Employee

    PhyCostAllocPostedFlag
    string

    Field Is Used When COST ALLOCATION ON EQUIPMENT WORKORDER Alternative Feature Is Installed; Indicates That The Record Is Already Posted To Avoid Duplicate Entry When Repost The Same Period

    PhyVertexSchdist
    number

    Vertex School District Code

    PhySadAccrualPaidoutOraseq
    number

    PY Salary Adjustment Benefit Accrual Paid-out Sequence Number

    PhyIePayeExclusionFlag
    string

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

    PhyIePayeCalcMethod
    string

    Ireland PAYE/USC Calculation Method: C=Cumulative, 1=Week/Month 1, E=Emergency, T=Temporary

    PhyIePrsiSubclassEe
    string

    Ireland PRSI subclass for employee.

    PhyIePrsiSubclassEr
    string

    Ireland PRSI subclass for employer.

    PhyRetainTransactionsInfo
    string

    Only for Information purpose-Indicate whether input transactions were retained after checks were voided

    PhyIuCreateDate
    date
    PhyIuUpdateDate
    date
    PhyVUuid
    string

    Unique Row ID

    PhyIuLastUpdateDate
    date
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
      "PhyActivateSeq": null,
      "PhyActualPayDate": null,
      "PhyActualPayDateFixFlag": null,
      "PhyActualPeriod": null,
      "PhyActualPlCode": null,
      "PhyActualWcbCode": null,
      "PhyActualWorkDate": null,
      "PhyAdjustment": null,
      "PhyAmount": null,
      "PhyApvoucherCreatedFlag": null,
      "PhyAssignedCheckNum": null,
      "PhyBatchNum": null,
      "PhyBillingAmt": null,
      "PhyBillingRate": null,
      "PhyCalculatedEarnings": null,
      "PhyCategory": null,
      "PhyChargeOutAmt": null,
      "PhyChargeOutRate": null,
      "PhyChequeSeqNumber": null,
      "PhyChequeVoidDate": null,
      "PhyChgPayrateForJobTsh": null,
      "PhyCklocCode": null,
      "PhyClearingDbAccCode": null,
      "PhyClearingDbDeptCode": null,
      "PhyComment": null,
      "PhyCompCode": "001",
      "PhyCostAllocPostedFlag": null,
      "PhyCostPoolJob": null,
      "PhyCreateGlFlag": null,
      "PhyDataType": null,
      "PhyDate": null,
      "PhyDeptCode": null,
      "PhyDetailSeq": null,
      "PhyDocumentNo": null,
      "PhyDrDeptCode": null,
      "PhyEmpCrAccCode": null,
      "PhyEmpDeptCode": null,
      "PhyEmpEiCode": null,
      "PhyEmpNo": "04538",
      "PhyEmpPygCode": null,
      "PhyEmpType": null,
      "PhyEmplrContr": null,
      "PhyEmplrContrAccCode": null,
      "PhyEmplrContrDeptCode": null,
      "PhyEmplrContrFlag": null,
      "PhyEqpBillAmt": null,
      "PhyEqpBillRate": null,
      "PhyEqpChargeAmt": null,
      "PhyEqpChargeRate": null,
      "PhyEqpCrAccCode": null,
      "PhyEqpDeptCode": null,
      "PhyEqpHours": null,
      "PhyEqpHrlyWmCode": null,
      "PhyEqpJccatCode": null,
      "PhyEquipCategory": null,
      "PhyEquipLocCode": null,
      "PhyEquipPhsCode": null,
      "PhyEquipTranNo": null,
      "PhyEquipment": null,
      "PhyEquipmentCost": null,
      "PhyExpClaimFlag": null,
      "PhyExpEndDate": null,
      "PhyExpStartDate": null,
      "PhyExpectedPostDate": null,
      "PhyFedJurisdiction": null,
      "PhyGlAccCode": null,
      "PhyGlpostFlag": null,
      "PhyGrossEarning": null,
      "PhyHireFlag": null,
      "PhyHomeCompCode": null,
      "PhyHomeDeptCode": null,
      "PhyHrlyEquipRate": null,
      "PhyHrsPaid": null,
      "PhyHrsWorked": null,
      "PhyIePayeCalcMethod": null,
      "PhyIePayeExclusionFlag": null,
      "PhyIePrsiSubclassEe": null,
      "PhyIePrsiSubclassEr": null,
      "PhyInclCertPyRepFlag": null,
      "PhyJob": null,
      "PhyLastUpdDate": "2015-05-22T09:40:46Z",
      "PhyLeaveTakenTmshtYear": null,
      "PhyLevCalcDate": null,
      "PhyLevCalcMethod": null,
      "PhyManualChkCrAccCode": null,
      "PhyManualChkProc": null,
      "PhyMasterSeq": null,
      "PhyMonthNumber": null,
      "PhyOriginalTransaction": null,
      "PhyPayAmount": null,
      "PhyPayDate": "2015-01-07",
      "PhyPayRate": null,
      "PhyPhase": null,
      "PhyPlCode": null,
      "PhyPlanCode": null,
      "PhyPlcPolicyNo": null,
      "PhyPloCode": null,
      "PhyPostDate": null,
      "PhyPostDateChangeDate": null,
      "PhyPprPeriod": 1,
      "PhyPprYear": 2015,
      "PhyPrevailingWageRate": null,
      "PhyPrintCheckOnly": null,
      "PhyPrnCode": "WK",
      "PhyProcessFlag": null,
      "PhyPwBasePayRate": null,
      "PhyPwCompCode": null,
      "PhyPwDiffAmount": null,
      "PhyPwDiffCalcDone": null,
      "PhyPwDiffDestBen": null,
      "PhyPwDiffRate": null,
      "PhyPwDifferentialBenFlag": null,
      "PhyPwFringeContractRate": null,
      "PhyPwFringeOtPremFlag": null,
      "PhyPwFringePayrollRate": null,
      "PhyPwJobCode": null,
      "PhyQuantity": null,
      "PhyRateCode": null,
      "PhyRatecdHrlyPrem": null,
      "PhyRatecdMultiplier": null,
      "PhyReceivableFlag": null,
      "PhyRedistRecalWcpl": null,
      "PhyRedistributedBurdenFlag": null,
      "PhyRefCheckNum": null,
      "PhyRefDate": null,
      "PhyRefDesc": null,
      "PhyResidenceGeocode": null,
      "PhyRetainTransactions": null,
      "PhyRetainTransactionsInfo": null,
      "PhyRetpayFlag": null,
      "PhySeqNo": 365440,
      "PhyShiftCode": null,
      "PhyStdUnionPayRate": null,
      "PhySuiWrlCode": null,
      "PhyTavCode1": null,
      "PhyTavCode2": null,
      "PhyTavCode3": null,
      "PhyTavCode4": null,
      "PhyTaxAmt1": null,
      "PhyTaxAmt2": null,
      "PhyTaxAmt3": null,
      "PhyTaxCode1": null,
      "PhyTaxCode2": null,
      "PhyTaxCode3": null,
      "PhyTaxPercent1": null,
      "PhyTaxPercent2": null,
      "PhyTaxPercent3": null,
      "PhyTaxtypeFlag": null,
      "PhyTotalTaxCreditAmt": null,
      "PhyTradeCode": null,
      "PhyTranCode": "NWHR",
      "PhyTranType": "BW",
      "PhyTshAfterChksFlag": null,
      "PhyUiFromMidyearForm": null,
      "PhyUkNicCategory": null,
      "PhyUkPayeTaxCode": null,
      "PhyUnionCode": null,
      "PhyUpdateBchFlag": null,
      "PhyUser": "BILL",
      "PhyUserTypeCode": null,
      "PhyVendor": null,
      "PhyVendorAddCode": null,
      "PhyVertexPsdcode": null,
      "PhyVertexSchdist": null,
      "PhyVoidckReversalFlag": null,
      "PhyWbsvCode1": null,
      "PhyWbsvCode2": null,
      "PhyWbsvCode3": null,
      "PhyWbsvCode4": null,
      "PhyWcbCode": null,
      "PhyWcbPolicyNo": null,
      "PhyWitmLineNumber": null,
      "PhyWoCode": null,
      "PhyWoExpCode": null,
      "PhyWoTranType": null,
      "PhyWorkCompCode": null,
      "PhyWorkGeocode": null,
      "PhyWorkLocation": null,
      "PhyIuCreateDate": null,
      "PhyIuUpdateDate": null,
      "PhyVUuid": "F2A198EBE3123688E05316821FACE54A",
      "PhyIuLastUpdateDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyemppayhist/F2A198EBE3123688E05316821FACE54A",
          "name": "pyemppayhist",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyemppayhist/F2A198EBE3123688E05316821FACE54A",
          "name": "pyemppayhist",
          "kind": "item"
        }
      ]
    }
    object