--- title: "Create new Benefit Code" slug: "create-new-benefit-code" updated: 2026-05-26T12:53:14Z published: 2026-05-26T12:53:48Z canonical: "developers.cmicglobal.com/create-new-benefit-code" --- > ## 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 new Benefit Code Post/hcm-rest-api/rest/1/pybenefit ## Create Benefits UI Location: Human Capital Management - Human Resources - Benefits Administration - Benefits - Master ### SecurityHTTPType basic Basic authentication Header parametersContent-TypestringExampleapplication/vnd.oracle.adf.resourceItem+json Body parametersobject Example{ "BenCode": "RST", "BenDescription": "test", "BenShortDesc": "roast", "BenType": "D", "BenBaseCode": "DALY", "BenCalcSeq": 91922.0, "BenAllocationMethod": "DEF", "BenForDepFlag": "N" }BenAllocationMethodstring 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 BenCodestring Required Identify the Benefit 💻 UI Fieldname: *Code Max length4 BenShortDescstring Required 💻 UI Fieldname: *Short Description Max length16 BenForDepFlagstring Required 💻 UI Fieldname: Dependent Enrollment Allowed Max length1 BenTypestring Required Identify the Type as HR/LM/PC 💻 UI Fieldname: *Type Max length1 BenDescriptionstring Required Describe the Benefit 💻 UI Fieldname: *Description Max length30 BenCalcSeqnumber Required 💻 UI Fieldname: *Calculation Sequence BenBaseCodestring Required The code which benefit is based Max length4 BenAssignedCheckNumnumber Max length8 BenCalcFlagstring 💻 UI Fieldname: Calculation Benefit Max length1 BenPrintCheckOnlystring 💻 UI Fieldname: Print Check Only Max length1 BenDedNamestring Max length30 BenBaseNamestring Max length30 BenLimitGrpNamestring Max length30 BenInclPyFcBurdenCalstring Y/N: Benefit Will Be Included Include In PY Forecast Burden Calculation, Available When PY FORECAST BURDEN CALCULATION Alternative Feature Is Installed Max length1 BenJobAllocationAllstring 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 BenEmpleContrFlagstring Max length1 BenCreateApVoucherstring 💻 UI Fieldname: Create Voucher For Accounts Payable Max length1 BenAmountnumber Value of the Benefit in appropriation to its type 💻 UI Fieldname: Amount Max length18 BenCreateSeprateCheckstring 💻 UI Fieldname: Process Separate Check For This Benefit Max length1 BenIuUpdateUserstring Max length30 BenExcludeFlagstring Flag to show if this benefit is to be calculated when no wages exist. 💻 UI Fieldname: Exclude Without Wages Max length1 BenAccrualPaidoutFlagstring Accural Paidout Benefit; Include In Accrual Paid-out Utility Max length1 BenLumpSum1planFlagstring 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 BenPrintOrdernumber Identify Whether Benefit is because of Prevailing Wage restiricti 💻 UI Fieldname: Print Order Max length4 BenLimitGrpCodestring 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 BenDeptAllocationstring The Burden will be allocated to the Timesheet Department 💻 UI Fieldname: Department Allocation Max length1 BenCalcPyOverheadFlagstring Y: PY Overhead will be calculated 💻 UI Fieldname: Calculate Overhead Max length1 BenUserstring The name of user who made the last change to the data Max length30 BenPwFlagstring Identify Whether Benefit is because of Prevailing Wage restiricti 💻 UI Fieldname: Prevailing Wage Max length1 BenIuCreateUserstring Max length30 BenGrpNamestring Max length30 BenIuCreateDatestring BenInclInGcfStaffFlagstring 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 BenBasecdAllocationFlagstring 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 BenGrpCodestring 💻 UI Fieldname: Reporting Group Max length4 BenVUuidstring Max length64 BenCashstring Identify Benefit to be paid as Cash Y/N 💻 UI Fieldname: Paid in Cash Max length1 BenIuUpdateDatestring BenPkgFlagstring "Y: The Lump Sum Benefit will be part of Package calculation for Salary employee Max length2 BenJobAllocationstring 💻 UI Fieldname: Job Allocation Max length1 BenWrlAllocationstring 💻 UI Fieldname: Work Location Allocation Max length1 BenInclInRetropayCalcFlagstring Yes to Include this Benefit in Retropay Calculation 💻 UI Fieldname: Include In Retropay Processing Max length1 BenProRatedFlagstring Y: The Lump Sum benefit will be prorated Max length2 BenLastUpdDatestring Date and Time stamp on which was modification was made BenDedCodestring Identify Whether Benefit is because of Prevailing Wage restiricti 💻 UI Fieldname: Effected Deduction Max length4 BenCommentstring General Comment on Benefit Max length60 Responses201 Created HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json ```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