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.

Breaking Changes

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: July 2026

Enterprise Content Management

Upload PO Invoice

Endpoint: ecm-rest-api/jersey/v1/UploadData/uploadPoInvoice
Notes: Enhanced API so that the Shiplist Number is an optional field in the PO detail section of the payload. When multiple PO detail lines share the same PO Line Number, users must provide the Shiplist Number in the payload to ensure accurate line selection.

Version Change Description Method Patch Reference
1 Enhanced API Shiplist Number is now an optional field POST Nexus 2 (24) Upload PO Invoice

Flysheets

Endpoint: ecm-rest-api/rest/v1/flysheets
Notes: Created new API to perform data insertion against UETD flysheets and associate the data with already existing documents in Image Manager.

Version Change Description Method Patch Reference
1 New API API added to insert data against flysheets POST Nexus 1 (23) Query Document Type Flysheets

Project Management

Subcontract Schedules

Endpoint: pm-rest-api/rest/1/scsched
Notes: Added uuid as primary key instead of composite key usage.

Version Change Description Method Patch Reference
1 Changed Attribute Type Composite primary keys were removed and ScschVUuid is now used as the primary key ALL Nexus 2 (24) Retrieve SC Details By Code

Subcontract Headers

Endpoint: pm-rest-api/rest/1/scmast
Notes: Modified API to remove existing composite primary keys and ScschVUuid is now used as the primary key.

Version Change Description Method Patch Reference
1 Enhanced API Removed ScmstProjOraseq and added ScmstProjVUuid attributes ALL Nexus 2 (24) Retrieve SC Headers By Code

Assign Partner To Project

Endpoint: /pm-rest-api/jersey/v1/assign-to-project/partner
Notes: Enhanced API to return proper error messages.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API to return proper error messages POST Nexus 1 (23) Assign partner to project

Assign Contact To Project

Endpoint: pm-rest-api/jersey/v1/assign-to-project/contact
Notes: Enhanced API to return proper error messages.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API to return proper error messages POST Nexus 1 (23) Assign contact to project

Delete Documents

Endpoint: pm-doc-rest-api/jersey/v2/deleteDoc/{id}
Notes: Enhanced API to return proper error messages.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API to return proper error messages DELETE Nexus 1 (23) TBD

Download Documents

Endpoint: pm-doc-rest-api/jersey/v1/downloadDoc
Notes: Enhanced API to return proper error messages.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API to return proper error messages GET Nexus 1 (23) Downloading Documents

Upload Documents

Endpoint: pm-doc-rest-api/jersey/v1/uploadDoc
Notes: Enhanced API to return proper error messages.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API to return proper error messages ALL Nexus 1 (23) Uploading Documents

User Roles

Endpoint: pm-rest-api/rest/1/pmuserrole
Notes: Enhanced API pagination rules to its original state.

Version Change Description Method Patch Reference
1 Enhanced API Enhanced API pagination rules to its original state GET Nexus 1 (23) Retrieve a Specific PM User Role By Code

Asset Management

Inventory

Endpoint: ci-rest-api/rest/1/ciitemhdr
Notes: Removed attributes from ciitemhdr.

Version Change Description Method Patch Reference
1 Removed Attributes CithIuCreateUser, CithIuUpdateUser, CithLastCstbchOraseq, CithMsdscOraseq, CithMsptOraseq, CithMszpcOraseq, CithRowid, CithTenantId, DiscriminatorCode ALL Nexus 2 (24) Retrieve a Specific Inventory Item Header
Inventory

Endpoint: ci-rest-api/rest/1/ciitemdetail
Notes: Removed attributes from ciitemdetail.

Version Change Description Method Patch Reference
1 Removed Attributes CitemdLastCstbchdOraseq, CitemdMsdscOraseq, CitemdMsptOraseq, CitemdMszpcOraseq, CitemdRowid, CitemdTruckClassOraseq ALL Nexus 2 (24) Retrieve Inventory Item Detail By Code
Fixed Assets

Endpoint: fa-rest-api/rest/1/faasset
Notes: Enhanced API to validate account code.

Version Change Description Method Patch Reference
1 Corrected View Validating account code in DB view. GET Nexus 1 (23) Fixed Assets

Financials

SC RFP Totals

Endpoint: ap-rest-api/rest/1/scRfpTotals
Notes: Modified scrfpdetail API to split into two separate endpoints to improve performance and maintain clear separation of concerns.

Version Change Description Method Patch Reference
1 New API ALL Nexus 2 (24) Retrieve SC RFP Totals

SC RFP Detail

Endpoint: ap-rest-api/rest/2/scrfpdetail
Notes: Modified API to split into two separate endpoints to improve performance and maintain clear separation of concerns.

Version Change Description Method Patch Reference
1 New API Version 2 created for performance optimization ALL Nexus 2 (24) Retrieve SC RFP Detail By Code

General Ledger

Endpoint: glrestapi/rest/v1/gltrialbalancebyacct
Notes: Modified entity object GlTrialBalanceByAcct to remove unnecessary primary keys.

Version Change Description Method Patch Reference
1 Removed Finder Attributes PrimaryKey: GlAccName, Gl2000CompArchDate, GlAccSort, GlCompName, Gl2000TableEndBal, GlAcctypeName, Gl2000CompOpenBalAmt, GlAccNum, Gl2000DeptCode1, GlAccClearFlag, Gl2000CreditActivityAmt, Gl2000OpenBal, Gl2000DeptName, GlAcctypeSeqNum, Gl2000DebitActivityAmt GET Nexus 2 (24) Retrieve GL Trial Balance by Account

Accounts Payable

Endpoint: ap-rest-api/rest/1/apvoucher
Notes: Enhancements to existing AP Voucher API to expand attributes and modify data type for VouNum attribute under header and detail.

Version Change Description Method Patch Reference
1 Data type VouNum: integer ApVoucherDetailViewObj: VdistVouNum: integer ALL Nexus 1 (23) Retrieve a Specific AP Voucher By Voucher Number

Version Change Description Method Patch Reference
1 Enhanced functionality Implemented changes to reference cash acc code field from contract ALL Nexus 1 (23) Retrieve a Specific AP Voucher By Voucher Number

Endpoint: ap-rest-api/rest/1/apreginvdetails
Notes: Fixed back-end validation. When inserting PO invoices through the API, system-generated distributions using a subledger control account will continue without validation, but any selected subledger account for overwrite—either for non-PO invoices or when overriding a PO invoice distribution—will now trigger validation and be blocked.

Version Change Description Method Patch Reference
1 Corrected View Fixed back-end validation for creating PO invoices. POST Nexus 1 (23) AP Registered Invoice Detail

Endpoint: ap-rest-api/rest/1/manualcheck
Notes: Fixed API validation of total amount between payment and invoice amount values passed.

Version Change Description Method Patch Reference
1 Corrected View Validating total amount on manual check. POST Nexus 1 (23) Manual Check

All APIs

Centralized API Exception Handling

Endpoints: Applies to all APIs
Notes: Effective Nexus 1, CMiC has introduced centralized error handling across all APIs. This ensures every API response follows a consistent, structured JSON format, making errors easier to trace, debug, and handle across all services.

Version Change Description Method Patch Reference
All Error Messages Standard http codes and error messages ALL Nexus 1 Best Practice - Global API Exception Handling

Human Capital Management

Employee Relatives

Endpoint: hcm-rest-api/rest/v3/hremrelatives
Notes: Created Version 3 of the hremrelatives endpoint to make the HR employee relationship code mandatory.

Version Change Description Method Patch Reference
v3 New API EdpRelCode is now a required field ALL Nexus 2 (24) Create a HR Employee Relative

Payroll Deduction

Endpoint: hcm-rest-api/rest/v3/pydeduction
Notes: Created Version 3 of the pydeduction endpoint to make the DedPriority field mandatory and automatically set to 1 upon insertion.

Version Change Description Method Patch Reference
v3 New API ALL Nexus 2 (24) Retrieve Deduction By Code

United Kingdom Payroll

Endpoint: hcm-rest-api/rest/1/ukgpayheader
Notes: Modified to return the correct primary keys for employee check number in response.

Version Change Description Method Patch Reference
1 Corrected View Added syscontext GET 21 UKG Pay Header

Vertex Location by City

Endpoint: hcm-rest-api/rest/1/vertexloccity
Notes: Enhanced view to allow passing user sys context.

Version Change Description Method Patch Reference
1 Modified finder attributes loczipcodestart, loczipcodeend GET 21 Vertex Location Code

Payroll Timesheets

Endpoint: hcm-rest-api/rest/1/pyemptimesheet
Notes: Modified to be system-calculated (from workcompcode, job, phase, and category) instead of passed in the payload, resolving miscalculation issues from duplicate fields. Also, cleaned up duplicate and non-functioning attributes.

Version Change Description Method Patch Reference
1 Removed Attributes TshCertSeq, TshIuCreateDate, TshIuLastUpdateDate, TshIuUpdateDate, TshPciLineUuid, TshSeqNo, TshUserField1, TshUserField2, TshUserField3, TshWbsSetupFlag, TshWbsvCode1, TshWbsvCode2, TshWbsvCode3, TshWbsvCode4 All 21 Payroll Timesheet

Project Controls

JC Foreign Batch Data File

Endpoint: jc-rest-api/jersey/v1/jcForeignBatchDataFile
Notes: A new Jersey API is created for bulk-importing JC Foreign Batch Data File records. It replaces the legacy REST BC endpoint for batch posting and resolves the performance, request-timeout, and empty-response issues reported against that endpoint.

Version Change Description Method Patch Reference
v1 New API POST Nexus 2 (24) Create a JC Foreign Batch Data File

Job Cost Transactions

Endpoint: jc-rest-api/rest/1/jctran
Notes: Enhanced API so that when an Employee Code is provided on the payload, the record in CMiC inherits the employee pay group security settings, making sensitive payroll information hidden in JCDETAIL once posted for users that do not have the privilege to see them.

Version Change Description Method Patch Reference
1 Enhanced API Payroll security is inherited from JctdSrcCode during API-created transactions POST Nexus 1 (23) Create JC Transaction

Contract Forecasting Archive

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

Version Change Description Method Patch Reference
1 New Finder ?orderBy=default GET Nexus 1 (23) New orderBy parameter for API sorting

Assign Cost Codes

Endpoint: jc-rest-api/rest/1/jcjobcostcodes
Notes: Modified to remove Company Name and Job Name to optimize.

Version Change Description Method Patch Reference
1 Removed Attribute GjcatCompName, GjcatJobName GET 22 Job Cost Codes (Job Phases)
Change Items (PCI/OCO)

Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Removed 'Phasedate' parameter from finders, to standardize with other API finders.

Version Change Description Method Patch Reference
1 Removed Finders selectCostCatCodes: phaseDate, selectByphaseDate: phaseDate GET 22 PCI Detail

Core System

System User

Endpoint: sys-rest-api/rest/1/sduser
Notes: API depreciated.

Version Change Description Method Patch Reference
1 Depreciated Replaced with API User. All 22 User
Copyright © 2024 CMiC All Rights Reserved