API Enhancements

Prev Next

Stay In the Loop

Sign up to receive email notifications about upcoming updates, releases, or changes.

Click subscribe or scan the QR code below.

Subscribe

QR Code for Microsoft Form

Last Update: January 2026

Opportunity Management

Organization

Endpoint: om-rest-api/rest/1/organization
Notes: New API created to retrieve OM-only organizations.

Version Change Description Method Patch Reference
1 New API Added API to retrieve organizations ALL 23 Retrieve Organization

Asset Management

Purchase Orders

Endpoint: po-rest-api/rest/1/poapprover
Notes: Enhanced API to always convert apprvcode to uppercase.

Version Change Description Method Patch Reference
1 Enhanced API apprvcode is converted to uppercase. PATCH 23 Update Approver

Endpoint: po-rest-api/rest/1/poNonStockItem
Notes: New API added to create and retrieve non-stock items on a purchase order.

Version Change Description Method Patch Reference
1 New API Added API to create and retrieve non-stock items ALL 23 Retrieve Non-Stock Items By Company Code, Item Code and Cost Code

Endpoint: po-rest-api/rest/1/poRoles
Notes: New API created to manage users' Purchase Order roles.

Version Change Description Method Patch Reference
1 New API ALL 23 Retrieve Purchase Order Roles for User By Company Code and User ID

Endpoint: po-rest-api/rest/1/poUserIdCrossRef
Notes: New API created to to manage User ID Cross Reference.

Version Change Description Method Patch Reference
1 New API ALL 23 Retrieve User Assigned With Tracking Code By Company Code, Tracking Code and User ID

Endpoint: po-rest-api/rest/1/podetail
Notes: Enhanced API to add orderBy=default to endpoint.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve Purchase Order Details By Code

Endpoint: po-rest-api/rest/1/pomaster
Notes: Enhanced API to add orderBy=default to endpoint.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default ALL 23 Retrieve Purchase Order Headers By Code

Endpoint: po-rest-api/rest/1/porequisition
Notes: CitrnBchType was added to the payload to let users view posted inventory transactions by batch type.

Version Change Description Method Patch Reference
1 Attributes added PoreqJobCompCode All 22 PO Requisition

Equipment

Endpoint: em-rest-api/rest/1/emtrantiment
Notes: Enhanded API structure to support batch (multi-part) insertion.

Version Change Description Method Patch Reference
1 Attributes added EmtrBchName All 21 Equipment Timesheets

Endpoint: em-rest-api/rest/1/emclassrates
Notes: New finder added to filter equipment rates by class.

Version Change Description Method Patch Reference
1 New Finder selectByCompClass GET 22 Equipment Rates

Endpoint: em-rest-api/rest/1/emclassjobrates
Notes: New finder added to filter equipment rates by job and class.

Version Change Description Method Patch Reference
1 New Finder selectByCompClass GET 22 Equipment Rates

Inventory

Endpoint: ci-rest-api/jersey/1/transWithoutReq
Notes: New API created for warehouse transfers without requisition.

Version Change Description Method Patch Reference
1 New API POST 23 Transfer Without Request

Endpoint: ci-rest-api/rest/1/citranposted
Notes: Enhanced API finder selectByBchNum to include AuditDate parameter.

Version Change Description Method Patch Reference
1 Added Finder Attributes selectByBchNum: AuditDate GET 23 Retrieve Inventory Posted Transactions By Code

Endpoint: ci-rest-api/rest/2/ciitem
Notes: New API created to address performance across successive data retrievals as pagination increases.

Version Change Description Method Patch Reference
2 New API Improves performance GET 23 Inventory Item

Endpoint: ci-rest-api/rest/1/citranposted
Notes: Enhanced allowing users view posted inventory transactions by batch type.

Version Change Description Method Patch Reference
1 Attributes added CitrnBchType GET 22 Inventory Posted Transactions

Financials

Accounts Payable

Endpoint: ap-rest-api/rest/1/apvoumemo
Notes: New API to create and query Accounts Payable Memos similar to front-end interface.

Version Change Description Method Patch Reference
1 New API API for creating and querying Accounts Payable memos All 23 Create Voucher Memo

Endpoint: /ap-rest-api/rest/2/validatepo
Notes: Optimized API to validate and exclude voided POs.

Version Change Description Method Patch Reference
2 Enhancement Validation modified to exclude voided POs POST 23 Validate PO

Endpoint: ap-rest-api/rest/1/apvoucher
Notes: Enhanced API to modify data type for VouNum attribute and enable Advance Payment functionality.

Version Change Description Method Patch Reference
1 Enhanced API Modified data type for VouNum and enabled Advance Payment functionality ALL 23 AP Voucher Header and Detail

Endpoint: ap-rest-api/rest/1/apvoucher
Notes: Enhanced the support for material stored in RFP programs.

Version Change Description Method Patch Reference
1 Unified View and Added Attribute ApVoucherDetailViewObj.VdistTranScschMatStoredAmt All 21 AP Voucher

Endpoint: ap-rest-api/rest/1/checkunpostedrfps
Notes: Enhanced to check for unposted RFP on Contract Change Orders by Company Code.

Version Change Description Method Patch Reference
1 Attributes added VouCompCode GET 22 Checkunpostedrfps

Endpoint: ap-rest-api/rest/1/Voiddeletevoucher
Notes: Enhanced to enforce unique record identification with vouNum, required fields, handle voidDate correctly, and return proper error codes and messages instead of false success responses.

Version Change Description Method Patch Reference
1 Attributes added VouNum POST 22 Voiddeletevoucher

Accounts Receivable

Endpoint: ar-rest-api/rest/1/arpayment
Notes: Enhanced API to include payment revision code and payment revision date.

Version Change Description Method Patch Reference
1 Enhanced API PayRevCode, PayRevDate ALL 23 Retrieve AR Payments by Code

Endpoint: ar-rest-api/rest/1/arinvoice
Notes: Enhanced to include Invoice amount, AR Invoice and Outstanding Amount.

Version Change Description Method Patch Reference
1 Attributes added InvAmt, InvArAmt, InvOutstandAmt All 22 AR Invoice
General Ledger

Endpoint: glrestapi/rest/v1/rtigenericgldepts
Notes: Enhanced API to include department creation and last modified date and time.

Version Change Description Method Patch Reference
1 Enhanced API DeptIuCreateDate, DeptIuUpdateDate ALL 23 Retrieve GL Departments By Code

Endpoint: glrestapi/rest/v1/gldtran
Notes: New API to create GL header Transactions.

Version Change Description Method POST Reference
1 New API All 22 GL Transactions

Endpoint: glrestapi/rest/v1/gljtran
Notes: New API to create GL detail transactions.

Version Change Description Method Patch Reference
1 New API POST 22 GL Transactions

Human Capital Management

Employee

Endpoint: hcm-rest-api/rest/1/pyemployee
Notes: Enhanced API to include the Apply Automatic Work Province flag, GC Bill Rate, and GC Charge Rate.

Version Change Description Method Patch Reference
1 Enhanced API EmpAutoWorkProvApply, EmpGcBillRate, EmpGcChargeRate ALL 23 Retrieve PY Employees By Code

Endpoint: hcm-rest-api/rest/1/pyemployee
Notes: Enhanced API to uncheck create, update, and delete flags in pyemployeeminViewObj to disable POST, PATCH, DELETE requests.

Version Change Description Method Patch Reference
1 Enhanced API Unchecked create, update, and delete flags for pyemployeeminViewObj ALL 23 Retrieve PY Employees By Code

Endpoint: hcm-rest-api/rest/1/pyemployee
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve PY Employees By Code

Payroll Timesheets

Endpoint: hcm-rest-api/rest/1/pyemptimesheet
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve PY Employee Timesheets By Code

Endpoint: hcm-rest-api/rest/1/pyemptimesheet
Notes: Enhanced to enable users to query and create productivity, cost, and billing rates for accurate hour calculations

Version Change Description Method Patch Reference
1 Attributes added TshBatchNum, TshDotBillRate, TshDotChargeRate, TshDotPayRate, TshNhBillRate, TshNhChargeRate, TshOhBillRate, TshOhChargeRate, TshOhPayRate, TshOtBillRate, TshOtChargeRate, TshOtPayRates All 21 Payroll Timesheet

Notes: Modified finder parameters to include batch number as an optional parameter

Version Change Description Method Patch Reference
1 Added Finder Attributes selectByEmpPeriod: empBatchNum selectByCodes: empBatchNum selectByEmpDate: empBatchNum GET 21 Payroll Timesheet
Construct Crew Time

Endpoint: hcm-rest-api/rest/1/pyctimecrew
Notes: Enhanced to include dispatch company, job code and equipment production units.

Version Change Description Method Patch Reference
1 Attributes added PyCtimeEmpIntViewObj.TshDispatchCompCode, PyCtimeEmpIntViewObj.TshDispatchJobCode, PyCtimeEqpIntViewObj.EmtrProductionUnit All 21 Crew Timesheet

Endpoint: hcm-rest-api/rest/1/pyctimeempint
Notes: Enhanced crew member timesheets to include dispatch company and Job code, and product units with comments.

Version Change Description Method Patch Reference
1 Attributes added TshDispatchCompCode, TshDispatchJobCode, TshProdUnitComment, TshProductionUnit All 21 Crew Individual Timesheet

Endpoint: hcm-rest-api/rest/1/pyctimeeqpint
Notes: Enhanced crew equipment timesheets to include dispatch company and Job code, and product units with comments.

Version Change Description Method Patch Reference
1 Attributes added TshDispatchCompCode, TshDispatchJobCode, TshProdUnitComment, TshProductionUnit All 21 Crew Equipment Timesheet

Project Controls

Job Cost

Endpoint: jc-rest-api/rest/1/jcjob
Notes: Enhanced API to include the Apply Phase Template flag and Job Phase Template Code to support phase template functionality.

Version Change Description Method Patch Reference
1 Attributes Added JobApplyPhsTemplateFlag, JobPhsTemplateCode ALL 23 Retrieve JC Jobs By Code

Endpoint: jc-rest-api/rest/1/jcjob
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve JC Jobs By Code

Endpoint: jc-rest-api/rest/1/jcjob
Notes: Enhanced API to include the default department code in a callable statement under generateAutoJobCode.

Version Change Description Method Patch Reference
1 Enhanced API Added default department code POST 23 Retrieve JC Jobs By Code

PCI Headers

Endpoint: cm-rest-api/rest/1/cmmast
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve PCI Masters By Code

Endpoint: cm-rest-api/rest/1/cmmast
Notes: Enhanced API to include new child attributes.

Version Change Description Method Patch Reference
1 Added Child Attributes RtiGenericCmDetailViewObj: CmdExchgEstBudgAmt, CmdExchgBudgEstUnitRate, CmdExchgBillUnitRate, CmdExchgBudgQuoteUnitRate, CmdExchgQuotedBudgAmt, CmdExchgBudgUnitRate ALL 23 Retrieve PCI Masters By Code

PCI Details

Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Retrieve PCI details By Code

Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Modified backend logic when assigning a subcontract to a PCI so that PCI Exchange columns are populated when SOV lines are split.

Version Change Description Method Patch Reference
1 Enhanced API Modified to populate PCI Exchange columns POST 23 Retrieve PCI details By Code

JC WIP

Endpoint: jc-rest-api/rest/1/jcwiprep
Notes: Enhanced API by adding new attributes.

Version Change Description Method Patch Reference
1 Attributes Added JcwrVUuid ALL 23 Retrieve JC WIP Report Export

Contract Forecasting Archive

Endpoint: jc-rest-api/rest/1/jccontforecastarch
Notes: Enhanced API by adding new attributes.

Version Change Description Method Patch Reference
1 Attributes Added JccfVUuid ALL 23 Retrieve a Specific JC Forecast Archives By Code

Subcontracts/Purchase Orders

Endpoint: pm-rest-api/rest/1/scmast
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Subcontract Master

Endpoint: pm-rest-api/rest/1/scmast
Notes: Enabled post function, to allow users to commit the Subcontract header and detail via API.

Version Change Description Method Patch Reference
1 Refined ScmstPost + Header and Child RtiGenericScSchedViewObj POST 22 Subcontract Master

Endpoint: pm-rest-api/rest/1/scsched
Notes: Enhanced API to support new parameter orderBy=default.

Version Change Description Method Patch Reference
1 Enhanced API orderBy=default GET 23 Subcontract SOV

Endpoint: pm-rest-api/rest/1/scsched
Notes: Enhanced API to include Advance Payment related attributes and replaced usage of generic exception handling with more specific standard.

Version Change Description Method Patch Reference
1 Enhanced API Added Advanced Payment attributes ALL 23 Subcontract SOV

Version Change Description Method Patch Reference
1 Enhanced API Improved generic exception handling message ALL 23 Subcontract SOV

Endpoint: pm-rest-api/rest/1/scsched
Notes: API optimized to support materials stored and to synchronize with UI functionality.

Version Change Description Method Patch Reference
1 Attributes added ScschCurrMatStoredAmt, ScschPrevMatStoredAmt ALL 22 Subcontract SOV

Change Items (PCI/OCO)

Endpoint: cm-rest-api/rest/1/cmmast
Notes: Combined into a single endpoint to simplify PCI creation, eliminating the need to send two separate payloads.

Version Change Description Method Patch Reference
1 Refined CmmPost + Header and Child RtiGenericCmDetailViewObj POST 22 PCI Master

Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Enhanced to allow users to include more data in the payload.

Version Change Description Method Patch Reference
1 Attributes added CmdCostCurrCode, CmdExchgBillAmt, CmdExchgBudgAmt, CmdRevenueCurrCode All 22 PCI Detail

Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Enhanced finder to include AuditDate filter parameter.

Version Change Description Method Patch Reference
1 Refined selectByphaseDate: auditDate selectCostCatCodes: auditDate GET 22 PCI Detail

Endpoint: cm-rest-api/rest/1/cmownerchangeorder
Notes: Endpoints optimized to accept a single combined payload, removing the need to send separate header and detail payloads.

Version Change Description Method Patch Reference
1 Refined CmocnPost + Header and Child RtiGenericCmDetailViewObj POST 22 Owner Change Order

Project Management

User Project Roles

Endpoint: pm-rest-api/rest/1/pmuserprojrole
Notes: Enhanced API by exposing isApi in the response payload and restored original access and fetch settings.

Version Change Description Method Patch Reference
1 Enhanced API Exposed isAPI in the response payload and restored original access ALL 23 TBD

Subcontract Headers

Endpoint: pm-rest-api/rest/1/scmast
Notes: Enhanced API to include new child attributes.

Version Change Description Method Patch Reference
1 Added Child Attributes RtiGenericScSchedViewObj: ScschPrevDepositAmt, ScschContDepositPct, ScschContDepositAmt, ScschCurrDepositAmt, ScschCurrDepositPct, ScschPrevDepositPct ALL 23 Retrieve SC Headers By Code

Subcontract Schedules

Endpoint: pm-rest-api/rest/1/scsched
Notes: Enhanced API to include Advance Payment related attributes.

Version Change Description Method Patch Reference
1 Attributes Added ScschContDepositAmt, ScschContDepositPct, ScschCurrDepositAmt, ScschCurrDepositPct, ScschPrevDepositAmt, ScschPrevDepositPct ALL 23 Retrieve SC Details By Code

Project Items

Endpoint: pm-rest-api/rest/1/pmprojectitem
Notes: Enhanced API to include the attribute pmpi_var_code with some validations.

Version Change Description Method Patch Reference
1 Enhanced API PmpiVarCode ALL 23 Retrieve PM Project Items By Code

User Roles

Endpoint: pm-rest-api/rest/1/pmuserrole
Notes: Enhanced API by adding new attributes.

Version Change Description Method Patch Reference
1 Attributes Added GpmurIuCreateUser, GpmurIuUpdateUser, GpmurProjOraseq, GpmurTenantId, GpmurUuid ALL 23 Retrieve a Specific PM User Role By Code
1 Added Finder Attributes PrimaryKey: GpmurContactCode, GpmurPartnTypeCode, GpmurPartnCode GET 23 Retrieve a Specific PM User Role By Code

Construct PM

Endpoint: pm-rest-api/rest/1/pmuserrole
Notes: Modified composite primary key (CompCode + ProjCode) and added full parameter set to retrieve data for a specific user and role across the system.

Version Change Description Method Patch Reference
1 New Finder CmocnPost + Header and Child RtiGenericCmDetailViewObj GET 21 Retrieve a Specific PM User Role By Code

Core System

User Role Security

Endpoint: sys-rest-api/rest/1/userrolesec
Notes: Enhanced API to refresh Role Name on insert or update.

Version Change Description Method Patch Reference
1 Enhanced API Refresh Role Name on insert or update GET 23 Add Security Role

System Contacts

Endpoint: sys-rest-api/rest/1/syscontaddpmrole
Notes: Created new API for adding system contacts to a PM role.

Version Change Description Method Patch Reference
1 New API GET 23 TBD

Documents by Object

Endpoint: sys-rest-api/rest/1/sysrelateddocquery
Notes: Enhanced API to support the PO Shipment object type and fix existing object types.

Version Change Description Method Patch Reference
1 Enhanced API Added enhancements for object types GET 23 Retrieve Documents by Object

User Roles

Endpoint: sys-rest-api/rest/1/sduserroles
Notes: New API created that assigns, removes, and retrieves user security roles.

Version Change Description Method Patch Reference
1 New API ALL 23 Retrieve User Roles By User ID, Role Code and Created Date

Job/Project Security

Endpoint: sys-rest-api/rest/1/jcjobsecgrpuser
Notes: New API created that assigns users to job/project security groups.

Version Change Description Method Patch Reference
1 New API ALL 23 Retrieve Users Assigned to Job Security Groups

Endpoint: sys-rest-api/rest/1/jcjobsecgrpproj
Notes: New API created that retrieves job/project security groups by project.

Version Change Description Method Patch Reference
1 New API POST 23 Retrieve Project Assigned to Security Groups

Endpoint: sys-rest-api/rest/1/jcjobsecgrpjob
Notes: New API created that assigns jobs to job/project security groups.

Version Change Description Method Patch Reference
1 New API POST 23 Assign Job to Security Group

Security Groups

Endpoint: sys-rest-api/rest/1/jcjobsecgrp
Notes: New API added that automates the creation of job/project security groups.

Version Change Description Method Patch Reference
1 New API ALL 23 Retrieve Security Groups By VUUID

User Maintenance

Endpoint: sys-rest-api/rest/v1/users
Notes: New API to create, retrieve, and remove users from CMiC.

Version Change Description Method Patch Reference
1 New API Adding new users All 22 Users

User Field Extensions

Endpoint: sys-rest-api/rest/1/sdobjusrextvalue
Notes: Corrected by adding missing object keys 5–10 to the view criteria.

Version Change Description Method Patch Reference
1 Added attributes SdObjUsrExtValueFinder: ObjectKey7,SdObjUsrExtValueFinder: ObjectKey6,SdObjUsrExtValueFinder: ObjectKey9, SdObjUsrExtValueFinder: ObjectKey5, SdObjUsrExtValueFinder:ObjectKey10, SdObjUsrExtValueFinder: ObjectKey8 All 22 System User Extension Values

Job Creation in BI/Analytics

Endpoint: sys-rest-api/rest/3/job_details
Notes: Enhanced to include date and user columns.

Version Change Description Method Patch Reference
3 Added attributes JdCreateDate, JdCreateUser, JdUpdateDate, dUpdateUser All 22 TBD
Copyright © 2024 CMiC All Rights Reserved