> ## 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 Company Benefits UI Location: Human Capital Management - Human Resources - Benefit Administration - Benefits - Company ### ## OpenAPI ````json POST /hcm-rest-api/rest/1/pycomben { "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/pycomben": { "post": { "tags": [ "HCM | Payroll Company Benefits" ], "summary": "Create new Benefit Code", "description": "## Create Company Benefits\n\nUI Location: Human Capital Management - Human Resources - Benefit Administration - Benefits - Company\n\n###", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CobPygCode": { "type": "string", "maxLength": 4, "description": "Identify the Pay Run Code" }, "CobCrAccCode": { "type": "string", "maxLength": 16, "description": "\n\n💻 UI Fieldname: \\*Credit Account Code" }, "CobFrqCode": { "type": "number", "maxLength": 2, "description": "" }, "CobBenCode": { "type": "string", "maxLength": 4, "description": "Identify the Benefit\n\n💻 UI Fieldname: \\*Benefit Code" }, "CobBenType": { "type": "string", "maxLength": 2, "description": "\n\n💻 UI Fieldname: Benefit Type" }, "CobPlanCode": { "type": "string", "maxLength": 10, "description": "\n\n💻 UI Fieldname: \\*Plan Code" }, "CobStartDate": { "type": "string", "description": "Effective Starting Date of the Benefit\n\n💻 UI Fieldname: \\*Start Date" }, "CobBenAmount": { "type": "number", "maxLength": 18, "description": "The respective value of the Benefit to be paid in appropriation t" }, "CobPrnCode": { "type": "string", "maxLength": 4, "description": "Identify the Pay Run Code" }, "CobPloCode": { "type": "string", "maxLength": 10, "description": "\n\n💻 UI Fieldname: \\*Plan Option" }, "CobDrAccCode": { "type": "string", "maxLength": 16, "description": "Respective Debit GL Account Code to the Benefit\n\n💻 UI Fieldname: \\*Debit Account Code" }, "CobRemittanceFrqCode": { "type": "number", "maxLength": 2, "description": "" }, "CobCompCode": { "type": "string", "maxLength": 8, "description": "" }, "CobEmplrContrDeptName": { "type": "string", "maxLength": 30, "description": "" }, "CobBenSecureFlag": { "type": "string", "maxLength": 1, "description": "print/display the Benefit in query screen only if checked to YES" }, "CobVendor": { "type": "string", "maxLength": 8, "description": "" }, "CobEndDate": { "type": "string", "description": "Effective Ending Date when to discontinue the Benefit\n\n💻 UI Fieldname: End Date" }, "CobCash": { "type": "string", "maxLength": 1, "description": "\n\n💻 UI Fieldname: Cash" }, "CobRemittanceTotAmt": { "type": "number", "maxLength": 18, "description": "" }, "CobElegBaseCode": { "type": "string", "maxLength": 4, "description": "Base Code to be used to determine the Eligibility" }, "CobEmpleContrAccCode": { "type": "string", "maxLength": 16, "description": "" }, "CobPrintBenFlag": { "type": "string", "maxLength": 1, "description": "Flag represents either benefits have to be dispalyed on Check stub/Direct Deposit Pay stub or not." }, "CobCalcAfterFirstChkFlag": { "type": "string", "maxLength": 1, "description": "Flag to indicate whether the benefit should be calculated only on first check (\\[Y\\]es or \\[N\\]o). Applicate only to hourly and percentage benefits" }, "CobDrAccName": { "type": "string", "maxLength": 4000, "description": "" }, "CobLastUpdDate": { "type": "string", "description": "Date and Time stamp of the last modification" }, "CobEmpleContrFactor": { "type": "string", "maxLength": 1, "description": "" }, "CobBaseCode": { "type": "string", "maxLength": 4, "description": "" }, "CobIuUpdateDate": { "type": "string", "description": "" }, "CobBaseName": { "type": "string", "maxLength": 30, "description": "" }, "CobDeptName": { "type": "string", "maxLength": 30, "description": "" }, "CobContrMaxAmt": { "type": "number", "maxLength": 18, "description": "" }, "CobIuCreateDate": { "type": "string", "description": "" }, "CobElegFrqCode": { "type": "number", "maxLength": 2, "description": "Frequency for the Eligibility" }, "CobComment": { "type": "string", "maxLength": 60, "description": "" }, "CobDeptCode": { "type": "string", "maxLength": 6, "description": "\n\n💻 UI Fieldname: Debit Dept. Code" }, "CobVenName": { "type": "string", "maxLength": 50, "description": "" }, "CobContrAmt": { "type": "number", "maxLength": 18, "description": "" }, "CobIuUpdateUser": { "type": "string", "maxLength": 30, "description": "" }, "CobEmplrContrDeptCode": { "type": "string", "maxLength": 6, "description": "\n\n💻 UI Fieldname: Credit Dept. Code" }, "CobPlnName": { "type": "string", "maxLength": 30, "description": "" }, "CobRemittanceAmtForAp": { "type": "string", "maxLength": 1, "description": "" }, "CobIuCreateUser": { "type": "string", "maxLength": 30, "description": "" }, "CobCrAccName": { "type": "string", "maxLength": 4000, "description": "" }, "CobElegAmt": { "type": "number", "maxLength": 18, "description": "Value for the Eligibility" }, "CobUser": { "type": "string", "maxLength": 30, "description": "The name of the User who did last Update" }, "CobVUuid": { "type": "string", "maxLength": 64, "description": "" }, "CobPloName": { "type": "string", "maxLength": 30, "description": "" }, "CobBenName": { "type": "string", "maxLength": 30, "description": "" } }, "required": [ "CobPygCode", "CobCrAccCode", "CobFrqCode", "CobBenCode", "CobPlanCode", "CobStartDate", "CobBenAmount", "CobPrnCode", "CobPloCode", "CobDrAccCode", "CobRemittanceFrqCode", "CobCompCode" ], "example": { "CobCompCode": "001", "CobPygCode": "NONE", "CobPrnCode": "SM", "CobBenCode": "AUTO", "CobPlanCode": "SINGLE", "CobPloCode": "T-FREE", "CobStartDate": "2022-11-16", "CobBenType": "D", "CobDrAccCode": 87354, "CobCrAccCode": 87354, "CobFrqCode": 3, "CobBenAmount": 1, "CobRemittanceFrqCode": 3 } } } } }, "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": { "CobEmpleContrAccCode": null, "CobVendor": null, "CobVenName": null, "CobCompCode": "001", "CobPrnCode": "SM", "CobPygCode": "NONE", "CobBenCode": "AUTO", "CobBenName": null, "CobStartDate": "2022-11-16T05:00:00+00:00", "CobEndDate": null, "CobFrqCode": 3, "CobBenAmount": 1, "CobDrAccCode": "87354", "CobDrAccName": null, "CobEmplrContrDeptCode": null, "CobEmplrContrDeptName": null, "CobPlanCode": "SINGLE", "CobPlnName": null, "CobPloCode": "T-FREE", "CobPloName": null, "CobBenType": "D", "CobEmpleContrFactor": null, "CobContrAmt": null, "CobContrMaxAmt": null, "CobCrAccCode": "87354", "CobCrAccName": null, "CobElegFrqCode": null, "CobElegAmt": null, "CobElegBaseCode": null, "CobBaseCode": null, "CobBaseName": null, "CobDeptCode": null, "CobDeptName": null, "CobPrintBenFlag": null, "CobCalcAfterFirstChkFlag": null, "CobComment": null, "CobRemittanceAmtForAp": null, "CobRemittanceFrqCode": 3, "CobRemittanceTotAmt": null, "CobBenSecureFlag": null, "CobUser": null, "CobCash": null, "CobLastUpdDate": null, "CobIuCreateDate": null, "CobIuCreateUser": null, "CobIuUpdateDate": null, "CobIuUpdateUser": null, "CobVUuid": "F296122AB85A72CCE05316821FAC52D0", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomben/F296122AB85A72CCE05316821FAC52D0", "name": "pycomben", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pycomben/F296122AB85A72CCE05316821FAC52D0", "name": "pycomben", "kind": "item" } ] } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````