Contents x
    API Enhancements
    • 21 Jan 2026
    • 12 Minutes to read
    • Print
    • Dark
      Light
    Contents

    API Enhancements

    • Updated on 21 Jan 2026
    • 12 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    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.

    VersionChangeDescriptionMethodPatchReference
    1New APIAdded API to retrieve organizationsALL23TBD

    Asset Management

    Purchase Orders

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIapprvcode is converted to uppercase.ALL23TBD

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

    VersionChangeDescriptionMethodPatchReference
    1New APIAdded API to create and retrieve non-stock itemsALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve Purchase Order Details By Code

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedPoreqJobCompCodeAll22PO Requisition
    Equipment

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedEmtrBchNameAll21Equipment Timesheets

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

    VersionChangeDescriptionMethodPatchReference
    1New FinderselectByCompClassGET22Equipment Rates

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

    VersionChangeDescriptionMethodPatchReference
    1New FinderselectByCompClassGET22Equipment Rates
    Inventory

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

    VersionChangeDescriptionMethodPatchReference
    1New APIPOST23Retrieve Inventory Posted Transactions By Code

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

    VersionChangeDescriptionMethodPatchReference
    1Added Finder AttributesselectByBchNum: AuditDateGET23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    2New APIImproves performanceGET23Inventory Item

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedCitrnBchTypeGET22 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIAPI for creating and querying Accounts Payable memosAll23TBD

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

    VersionChangeDescriptionMethodPatchReference
    2EnhancementValidation modified to exclude voided POsPOST23Validate PO

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIModified data type for VouNum and enabled Advance Payment functionalityALL23AP Voucher Header and Detail

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

    VersionChangeDescriptionMethodPatchReference
    1Unified View and Added AttributeApVoucherDetailViewObj.VdistTranScschMatStoredAmtAll21AP Voucher

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedVouCompCodeGET22Checkunpostedrfps

    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.

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedVouNumPOST22Voiddeletevoucher
    Accounts Receivable

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIPayRevCode, PayRevDateALL23Retrieve AR Payments by Code

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedInvAmt, InvArAmt, InvOutstandAmtAll22AR Invoice
    General Ledger

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIDeptIuCreateDate, DeptIuUpdateDateALL23Retrieve GL Departments By Code

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

    VersionChangeDescriptionMethodPOSTReference
    1New APIAll22GL Transactions

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

    VersionChangeDescriptionMethodPatchReference
    1New APIPOST22GL 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIEmpAutoWorkProvApply, EmpGcBillRate, EmpGcChargeRateALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIUnchecked create, update, and delete flags for pyemployeeminViewObjALL23Retrieve PY Employees By Code

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve PY Employees By Code
    Payroll Timesheets

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve 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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedTshBatchNum, TshDotBillRate, TshDotChargeRate, TshDotPayRate, TshNhBillRate, TshNhChargeRate, TshOhBillRate, TshOhChargeRate, TshOhPayRate, TshOtBillRate, TshOtChargeRate, TshOtPayRatesAll21Payroll Timesheet

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

    VersionChangeDescriptionMethodPatchReference
    1Added Finder AttributesselectByEmpPeriod: empBatchNum selectByCodes: empBatchNum selectByEmpDate: empBatchNumGET21Payroll Timesheet
    Construct Crew Time

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedPyCtimeEmpIntViewObj.TshDispatchCompCode, PyCtimeEmpIntViewObj.TshDispatchJobCode, PyCtimeEqpIntViewObj.EmtrProductionUnitAll21Crew 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.

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedTshDispatchCompCode, TshDispatchJobCode, TshProdUnitComment, TshProductionUnitAll21Crew 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.

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedTshDispatchCompCode, TshDispatchJobCode, TshProdUnitComment, TshProductionUnitAll21Crew 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.

    VersionChangeDescriptionMethodPatchReference
    1Attributes AddedJobApplyPhsTemplateFlag, JobPhsTemplateCodeALL23Retrieve JC Jobs By Code

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIAdded default department codePOST23Retrieve JC Jobs By Code
    PCI Headers

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve PCI Masters By Code

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

    VersionChangeDescriptionMethodPatchReference
    1Added Child AttributesRtiGenericCmDetailViewObj: CmdExchgEstBudgAmt, CmdExchgBudgEstUnitRate, CmdExchgBillUnitRate, CmdExchgBudgQuoteUnitRate, CmdExchgQuotedBudgAmt, CmdExchgBudgUnitRateALL23Retrieve PCI Masters By Code
    PCI Details

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIModified to populate PCI Exchange columnsPOST23Retrieve PCI details By Code
    JC WIP

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes AddedJcwrVUuidALL23Retrieve JC WIP Report Export
    Contract Forecasting Archive

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes AddedJccfVUuidALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Subcontract Master

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

    VersionChangeDescriptionMethodPatchReference
    1RefinedScmstPost + Header and Child RtiGenericScSchedViewObjPOST22Subcontract Master

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIorderBy=defaultGET23Subcontract 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIAdded Advanced Payment attributesALL23Subcontract SOV
    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIImproved generic exception handling messageALL23Subcontract SOV

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedScschCurrMatStoredAmt, ScschPrevMatStoredAmtALL22Subcontract 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.

    VersionChangeDescriptionMethodPatchReference
    1RefinedCmmPost + Header and Child RtiGenericCmDetailViewObjPOST22PCI Master

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes addedCmdCostCurrCode, CmdExchgBillAmt, CmdExchgBudgAmt, CmdRevenueCurrCodeAll22PCI Detail

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

    VersionChangeDescriptionMethodPatchReference
    1RefinedselectByphaseDate: auditDate selectCostCatCodes: auditDateGET22PCI 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.

    VersionChangeDescriptionMethodPatchReference
    1RefinedCmocnPost + Header and Child RtiGenericCmDetailViewObjPOST22Owner 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIExposed isAPI in the response payload and restored original accessALL23TBD
    Subcontract Headers

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

    VersionChangeDescriptionMethodPatchReference
    1Added Child AttributesRtiGenericScSchedViewObj: ScschPrevDepositAmt, ScschContDepositPct, ScschContDepositAmt, ScschCurrDepositAmt, ScschCurrDepositPct, ScschPrevDepositPctALL23Retrieve SC Headers By Code
    Subcontract Schedules

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes AddedScschContDepositAmt, ScschContDepositPct, ScschCurrDepositAmt, ScschCurrDepositPct, ScschPrevDepositAmt, ScschPrevDepositPctALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIPmpiVarCodeALL23Retrieve PM Project Items By Code
    User Roles

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

    VersionChangeDescriptionMethodPatchReference
    1Attributes AddedGpmurIuCreateUser, GpmurIuUpdateUser, GpmurProjOraseq, GpmurTenantId, GpmurUuidALL23Retrieve a Specific PM User Role By Code
    1Added Finder AttributesPrimaryKey: GpmurContactCode, GpmurPartnTypeCode, GpmurPartnCodeGET23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1New FinderCmocnPost + Header and Child RtiGenericCmDetailViewObjGET21Owner Change Order

    Core System

    User Role Security

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

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIRefresh Role Name on insert or updateGET23TBD
    System Contacts

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

    VersionChangeDescriptionMethodPatchReference
    1New APIGET23TBD
    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.

    VersionChangeDescriptionMethodPatchReference
    1Enhanced APIAdded enhancements for object typesGET23Retrieve Documents by Object
    User Roles

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

    VersionChangeDescriptionMethodPatchReference
    1New APIALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIALL23Retrieve 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIPOST23Retrieve Project Assigned to Security Groups

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

    VersionChangeDescriptionMethodPatchReference
    1New APIPOST23Assign 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.

    VersionChangeDescriptionMethodPatchReference
    1New APIALL23Retrieve Security Groups By VUUID
    User Maintenance

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

    VersionChangeDescriptionMethodPatchReference
    1New APIAdding new usersAll22Users
    User Field Extensions

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

    VersionChangeDescriptionMethodPatchReference
    1Added attributesSdObjUsrExtValueFinder: ObjectKey7,SdObjUsrExtValueFinder: ObjectKey6,SdObjUsrExtValueFinder: ObjectKey9, SdObjUsrExtValueFinder: ObjectKey5, SdObjUsrExtValueFinder:ObjectKey10, SdObjUsrExtValueFinder: ObjectKey8All22System User Extension Values
    Job Creation in BI/Analytics

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

    VersionChangeDescriptionMethodPatchReference
    3Added attributesJdCreateDate, JdCreateUser, JdUpdateDate, dUpdateUserAll22TBD
    What's Next
    Contact Us
    Copyright © 2024 CMiC All Rights Reserved