> ## 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 > ## Create Benefits UI Location: Human Capital Management - Human Resources - Benefits Administration - Benefits - Master ### ## OpenAPI ````json POST /hcm-rest-api/rest/1/pybenefit { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/hcm-rest-api/rest/1/pybenefit": { "post": { "tags": [ "HCM | Payroll Master Benefits" ], "summary": "Create new Benefit Code", "description": "## Create Benefits\n\nUI Location: Human Capital Management - Human Resources - Benefits Administration - Benefits - Master\n\n###", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "BenAllocationMethod": { "type": "string", "maxLength": 4, "description": "Job allocation method: DEF=default method, BASE=base wage, HRWK=hours worked, HRPD=hours paid. Currently only applicable for non-pw job allocation." }, "BenCode": { "type": "string", "maxLength": 4, "description": "Identify the Benefit\n\n💻 UI Fieldname: \\*Code" }, "BenShortDesc": { "type": "string", "maxLength": 16, "description": "\n\n💻 UI Fieldname: \\*Short Description" }, "BenForDepFlag": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Dependent Enrollment Allowed" }, "BenType": { "type": "string", "maxLength": 1, "description": "Identify the Type as HR/LM/PC\n\n💻 UI Fieldname: \\*Type" }, "BenDescription": { "type": "string", "maxLength": 30, "description": "Describe the Benefit\n\n💻 UI Fieldname: \\*Description" }, "BenCalcSeq": { "type": "number", "description": "\n\n💻 UI Fieldname: \\*Calculation Sequence" }, "BenBaseCode": { "type": "string", "maxLength": 4, "description": "The code which benefit is based" }, "BenAssignedCheckNum": { "type": "number", "maxLength": 8, "description": "" }, "BenCalcFlag": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Calculation Benefit" }, "BenPrintCheckOnly": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Print Check Only" }, "BenDedName": { "type": "string", "maxLength": 30, "description": "" }, "BenBaseName": { "type": "string", "maxLength": 30, "description": "" }, "BenLimitGrpName": { "type": "string", "maxLength": 30, "description": "" }, "BenInclPyFcBurdenCal": { "type": "string", "maxLength": 1, "description": "Y/N: Benefit Will Be Included Include In PY Forecast Burden Calculation, Available When PY FORECAST BURDEN CALCULATION Alternative Feature Is Installed" }, "BenJobAllocationAll": { "type": "string", "maxLength": 1, "description": "Flag to indicate if non prevailing wage benefits will also be charged to prevailing wage jobs.\n\n💻 UI Fieldname: Allocate Non Prevailing Wage Benefits to Prevailing Wage Jobs" }, "BenEmpleContrFlag": { "type": "string", "maxLength": 1, "description": "" }, "BenCreateApVoucher": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Create Voucher For Accounts Payable" }, "BenAmount": { "type": "number", "maxLength": 18, "description": "Value of the Benefit in appropriation to its type\n\n💻 UI Fieldname: Amount" }, "BenCreateSeprateCheck": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Process Separate Check For This Benefit" }, "BenIuUpdateUser": { "type": "string", "maxLength": 30, "description": "" }, "BenExcludeFlag": { "type": "string", "maxLength": 1, "description": "Flag to show if this benefit is to be calculated when no wages exist.\n\n💻 UI Fieldname: Exclude Without Wages" }, "BenAccrualPaidoutFlag": { "type": "string", "maxLength": 1, "description": "Accural Paidout Benefit; Include In Accrual Paid-out Utility" }, "BenLumpSum1planFlag": { "type": "string", "maxLength": 1, "description": "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.\n\n💻 UI Fieldname: Employee Level Lump Sum Benefit. Pay Only One Plan Per Pay Period" }, "BenPrintOrder": { "type": "number", "maxLength": 4, "description": "Identify Whether Benefit is because of Prevailing Wage restiricti\n\n💻 UI Fieldname: Print Order" }, "BenLimitGrpCode": { "type": "string", "maxLength": 4, "description": "An optional code to group related benefits in order to apply a maximum limit on the sum.\n\n💻 UI Fieldname: Maximum Limit Group Code" }, "BenDeptAllocation": { "type": "string", "maxLength": 1, "description": "The Burden will be allocated to the Timesheet Department\n\n💻 UI Fieldname: Department Allocation" }, "BenCalcPyOverheadFlag": { "type": "string", "maxLength": 1, "description": "Y: PY Overhead will be calculated\n\n💻 UI Fieldname: Calculate Overhead" }, "BenUser": { "type": "string", "maxLength": 30, "description": "The name of user who made the last change to the data" }, "BenPwFlag": { "type": "string", "maxLength": 1, "description": "Identify Whether Benefit is because of Prevailing Wage restiricti\n\n💻 UI Fieldname: Prevailing Wage" }, "BenIuCreateUser": { "type": "string", "maxLength": 30, "description": "" }, "BenGrpName": { "type": "string", "maxLength": 30, "description": "" }, "BenIuCreateDate": { "type": "string", "description": "" }, "BenInclInGcfStaffFlag": { "type": "string", "maxLength": 1, "description": "Flag to indicate whether the benefit should be included in the salary on the Staff tab of GC Monitor\n\n💻 UI Fieldname: Include In Salary In GC Monitor" }, "BenBasecdAllocationFlag": { "type": "string", "maxLength": 1, "description": "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.\n\n💻 UI Fieldname: Job Allocation Using User-Defined Base Code" }, "BenGrpCode": { "type": "string", "maxLength": 4, "description": "\n\n💻 UI Fieldname: Reporting Group" }, "BenVUuid": { "type": "string", "maxLength": 64, "description": "" }, "BenCash": { "type": "string", "maxLength": 1, "description": "Identify Benefit to be paid as Cash Y/N\n\n💻 UI Fieldname: Paid in Cash" }, "BenIuUpdateDate": { "type": "string", "description": "" }, "BenPkgFlag": { "type": "string", "maxLength": 2, "description": "\"Y: The Lump Sum Benefit will be part of Package calculation for Salary employee" }, "BenJobAllocation": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Job Allocation" }, "BenWrlAllocation": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Work Location Allocation" }, "BenInclInRetropayCalcFlag": { "type": "string", "maxLength": 1, "description": "Yes to Include this Benefit in Retropay Calculation\n\n💻 UI Fieldname: Include In Retropay Processing" }, "BenProRatedFlag": { "type": "string", "maxLength": 2, "description": "Y: The Lump Sum benefit will be prorated" }, "BenLastUpdDate": { "type": "string", "description": "Date and Time stamp on which was modification was made" }, "BenDedCode": { "type": "string", "maxLength": 4, "description": "Identify Whether Benefit is because of Prevailing Wage restiricti\n\n💻 UI Fieldname: Effected Deduction" }, "BenComment": { "type": "string", "maxLength": 60, "description": "General Comment on Benefit" } }, "required": [ "BenAllocationMethod", "BenCode", "BenShortDesc", "BenForDepFlag", "BenType", "BenDescription", "BenCalcSeq", "BenBaseCode" ], "example": { "BenCode": "RST", "BenDescription": "test", "BenShortDesc": "roast", "BenType": "D", "BenBaseCode": "DALY", "BenCalcSeq": 91922, "BenAllocationMethod": "DEF", "BenForDepFlag": "N" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/vnd.oracle.adf.resourceItem+json" } ], "responses": { "201": { "description": "Created", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourceitem+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "example": { "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" } ] } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````