Contents x
      Create new Benefit Code
      • 27 Feb 2025
      • 3 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Create new Benefit Code

      • Updated on 27 Feb 2025
      • 3 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Post
      /hcm-rest-api/rest/1/pybenefit

      Create Benefits

      UI Location: Human Capital Management - Human Resources - Benefits Administration - Benefits - Master

      Security
      HTTP
      Type basic

      Basic authentication

      Header parameters
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceItem+json
      Body parameters
      object
      Example{ "BenCode": "RST", "BenDescription": "test", "BenShortDesc": "roast", "BenType": "D", "BenBaseCode": "DALY", "BenCalcSeq": 91922.0, "BenAllocationMethod": "DEF", "BenForDepFlag": "N" }
      BenAllocationMethod
      string Required

      Job allocation method: DEF=default method, BASE=base wage, HRWK=hours worked, HRPD=hours paid. Currently only applicable for non-pw job allocation.

      Max length4
      BenCode
      string Required

      Identify the Benefit

      💻 UI Fieldname: *Code

      Max length4
      BenShortDesc
      string Required

      💻 UI Fieldname: *Short Description

      Max length16
      BenForDepFlag
      string Required

      💻 UI Fieldname: Dependent Enrollment Allowed

      Max length1
      BenType
      string Required

      Identify the Type as HR/LM/PC

      💻 UI Fieldname: *Type

      Max length1
      BenDescription
      string Required

      Describe the Benefit

      💻 UI Fieldname: *Description

      Max length30
      BenCalcSeq
      number Required

      💻 UI Fieldname: *Calculation Sequence

      BenBaseCode
      string Required

      The code which benefit is based

      Max length4
      BenAssignedCheckNum
      number
      Max length8
      BenCalcFlag
      string

      💻 UI Fieldname: Calculation Benefit

      Max length1
      BenPrintCheckOnly
      string

      💻 UI Fieldname: Print Check Only

      Max length1
      BenDedName
      string
      Max length30
      BenBaseName
      string
      Max length30
      BenLimitGrpName
      string
      Max length30
      BenInclPyFcBurdenCal
      string

      Y/N: Benefit Will Be Included Include In PY Forecast Burden Calculation, Available When PY FORECAST BURDEN CALCULATION Alternative Feature Is Installed

      Max length1
      BenJobAllocationAll
      string

      Flag to indicate if non prevailing wage benefits will also be charged to prevailing wage jobs.

      💻 UI Fieldname: Allocate Non Prevailing Wage Benefits to Prevailing Wage Jobs

      Max length1
      BenEmpleContrFlag
      string
      Max length1
      BenCreateApVoucher
      string

      💻 UI Fieldname: Create Voucher For Accounts Payable

      Max length1
      BenAmount
      number

      Value of the Benefit in appropriation to its type

      💻 UI Fieldname: Amount

      Max length18
      BenCreateSeprateCheck
      string

      💻 UI Fieldname: Process Separate Check For This Benefit

      Max length1
      BenIuUpdateUser
      string
      Max length30
      BenExcludeFlag
      string

      Flag to show if this benefit is to be calculated when no wages exist.

      💻 UI Fieldname: Exclude Without Wages

      Max length1
      BenAccrualPaidoutFlag
      string

      Accural Paidout Benefit; Include In Accrual Paid-out Utility

      Max length1
      BenLumpSum1planFlag
      string

      Applicable for EMPLOYEE LEVEL lump sum benefit. When Y only one plan/option will be paid per pay period. This address for example health benefit whereby employee changes plan in the middle of a pay period.

      💻 UI Fieldname: Employee Level Lump Sum Benefit. Pay Only One Plan Per Pay Period

      Max length1
      BenPrintOrder
      number

      Identify Whether Benefit is because of Prevailing Wage restiricti

      💻 UI Fieldname: Print Order

      Max length4
      BenLimitGrpCode
      string

      An optional code to group related benefits in order to apply a maximum limit on the sum.

      💻 UI Fieldname: Maximum Limit Group Code

      Max length4
      BenDeptAllocation
      string

      The Burden will be allocated to the Timesheet Department

      💻 UI Fieldname: Department Allocation

      Max length1
      BenCalcPyOverheadFlag
      string

      Y: PY Overhead will be calculated

      💻 UI Fieldname: Calculate Overhead

      Max length1
      BenUser
      string

      The name of user who made the last change to the data

      Max length30
      BenPwFlag
      string

      Identify Whether Benefit is because of Prevailing Wage restiricti

      💻 UI Fieldname: Prevailing Wage

      Max length1
      BenIuCreateUser
      string
      Max length30
      BenGrpName
      string
      Max length30
      BenIuCreateDate
      string
      BenInclInGcfStaffFlag
      string

      Flag to indicate whether the benefit should be included in the salary on the Staff tab of GC Monitor

      💻 UI Fieldname: Include In Salary In GC Monitor

      Max length1
      BenBasecdAllocationFlag
      string

      Y/N: Whether to job allocate based on user-defined base code definition (only applicable under certain conditions, see benefit maint. and PY processing). [N] will use original standard allocation.

      💻 UI Fieldname: Job Allocation Using User-Defined Base Code

      Max length1
      BenGrpCode
      string

      💻 UI Fieldname: Reporting Group

      Max length4
      BenVUuid
      string
      Max length64
      BenCash
      string

      Identify Benefit to be paid as Cash Y/N

      💻 UI Fieldname: Paid in Cash

      Max length1
      BenIuUpdateDate
      string
      BenPkgFlag
      string

      "Y: The Lump Sum Benefit will be part of Package calculation for Salary employee

      Max length2
      BenJobAllocation
      string

      💻 UI Fieldname: Job Allocation

      Max length1
      BenWrlAllocation
      string

      💻 UI Fieldname: Work Location Allocation

      Max length1
      BenInclInRetropayCalcFlag
      string

      Yes to Include this Benefit in Retropay Calculation

      💻 UI Fieldname: Include In Retropay Processing

      Max length1
      BenProRatedFlag
      string

      Y: The Lump Sum benefit will be prorated

      Max length2
      BenLastUpdDate
      string

      Date and Time stamp on which was modification was made

      BenDedCode
      string

      Identify Whether Benefit is because of Prevailing Wage restiricti

      💻 UI Fieldname: Effected Deduction

      Max length4
      BenComment
      string

      General Comment on Benefit

      Max length60
      Responses
      201

      Created

      Headers
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceitem+json
      {
  "BenCode": "LST",
  "BenDescription": "test",
  "BenShortDesc": "roast",
  "BenGrpCode": null,
  "BenGrpName": null,
  "BenPwFlag": null,
  "BenType": "D",
  "BenAmount": null,
  "BenBaseCode": "DALY",
  "BenBaseName": null,
  "BenCash": null,
  "BenJobAllocation": null,
  "BenPrintOrder": null,
  "BenDedCode": null,
  "BenDedName": null,
  "BenCalcSeq": 91923,
  "BenEmpleContrFlag": null,
  "BenComment": null,
  "BenForDepFlag": "N",
  "BenCalcFlag": null,
  "BenWrlAllocation": null,
  "BenJobAllocationAll": null,
  "BenCreateApVoucher": null,
  "BenExcludeFlag": null,
  "BenPrintCheckOnly": null,
  "BenAssignedCheckNum": null,
  "BenCreateSeprateCheck": null,
  "BenLimitGrpCode": null,
  "BenLimitGrpName": null,
  "BenInclInGcfStaffFlag": null,
  "BenCalcPyOverheadFlag": null,
  "BenDeptAllocation": null,
  "BenAllocationMethod": "DEF",
  "BenUser": null,
  "BenLastUpdDate": null,
  "BenBasecdAllocationFlag": null,
  "BenAccrualPaidoutFlag": null,
  "BenInclPyFcBurdenCal": null,
  "BenInclInRetropayCalcFlag": null,
  "BenLumpSum1planFlag": null,
  "BenIuCreateDate": null,
  "BenIuCreateUser": null,
  "BenIuUpdateDate": null,
  "BenIuUpdateUser": null,
  "BenProRatedFlag": null,
  "BenPkgFlag": null,
  "BenVUuid": "F296122AB84272CCE05316821FAC52D0",
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/F296122AB84272CCE05316821FAC52D0",
      "name": "pybenefit",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pybenefit/F296122AB84272CCE05316821FAC52D0",
      "name": "pybenefit",
      "kind": "item"
    }
  ]
}
      object
      What's Next
      Contact Us
      Copyright © 2024 CMiC All Rights Reserved