Stay In the Loop
Sign up to receive email notifications about upcoming updates, releases, or changes.
Click subscribe or scan the QR code below.
Last Update: May 2026
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 | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Data type | VouNum: integer ApVoucherDetailViewObj: VdistVouNum: integer | ALL | Nexus 1 (23) | May 16, 2026 | 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 sub-ledger control account will continue without validation, but any selected sub-ledger 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 | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Enhancement | Modified back-end logic | POST | 22 | January 17, 2026 | UKG Pay Header |
Project Management
Endpoint: pm-rest-api/rest/1/pmuserrole
Notes: Enhanced API pagination rules to its original state.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Enhanced API | Enhanced API pagination rules to its original state | GET | Nexus 1 (23) | May 16, 2026 | Retrieve a Specific PM User Role By Code |
Endpoint: pm-doc-rest-api/rest/v1/pmproject
Notes: Removed unnecessary attributes form the primary key constraint in the PmprojectsecV entity object.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Removed Finder Attributes | PrimaryKey: PmpCompCode, PmpProjName, PmpProjCode | GET | Nexus 1 (23) | May 16, 2026 | Create a PM Project |
Endpoint: pm-rest-api/rest/1/scsched
Notes: Added uuid as primary key instead of composite key usage.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Changed Attribute Type | Changed from composite PK to uuid PK | ALL | Nexus 1 (23) | May 16, 2026 | Retrieve SC Details By Code |
Asset Management
Endpoint: ci-rest-api/rest/1/ciitem
Notes: This endpoint will be depreciated as of Nexus 2 (Patch 24)
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Depreciated | Version 2 released on Nexus 1 | GET | Nexus 2 (24) | November 2026 | Inventory Item |
All APIs
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 | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| All | Error Messages | Standard http codes and error messages | ALL | Nexus 1 (23) | Q2 2026 | Best Practice - Global API Exception Handling |
Human Capital Management
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 | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Corrected View | Added syscontext | GET | 21 | May 31, 2025 | UKG Pay Header |
Endpoint: hcm-rest-api/rest/1/vertexloccity
Notes: Enhanced view to allow passing user sys context.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Modified finder attributes | loczipcodestart, loczipcodeend | GET | 21 | May 31, 2025 | Vertex Location Code |
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 | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Removed Attributes | TshCertSeq, TshIuCreateDate, TshIuLastUpdateDate, TshIuUpdateDate, TshPciLineUuid, TshSeqNo, TshUserField1, TshUserField2, TshUserField3, TshWbsSetupFlag, TshWbsvCode1, TshWbsvCode2, TshWbsvCode3, TshWbsvCode4 | All | 21 | May 31, 2025 | Payroll Timesheet |
Project Controls
Endpoint: jc-rest-api/rest/1/jccontforecastarch
Notes: Enhanced API to support vuuid and new parameter orderBy=default.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Enhanced API | Added JccfVUuid and ?orderBy=default | GET | Nexus 1 (23) | May 16, 2026 | Retrieve a Specific JC Forecast Archives By Code |
Endpoint: cm-rest-api/rest/1/cmmast
Notes: CmdQuotedBudgAmt attribute type is converted to Big Decimal.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Changed Attribute Type | CmdQuotedBudgAmt attribute type changed to java.math.BigDecimal | ALL | Nexus 1 (23) | May 16, 2026 | Retrieve PCI Masters By Code |
Endpoint: cm-rest-api/rest/1/cmdetail
Notes: CmdQuotedBudgAmt attribute type is converted to Big Decimal.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Changed Attribute Type | CmdQuotedBudgAmt attribute type changed to java.math.BigDecimal | ALL | Nexus 1 (23) | May 16, 2026 | Job Cost Codes (Job Phases) |
Endpoint: jc-rest-api/rest/1/jcjobcostcodes
Notes: Modified to remove Company Name and Job Name to optimize.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Removed Attribute | GjcatCompName, GjcatJobName | GET | 22 | Nov. 15, 2025 | Job Cost Codes (Job Phases) |
Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Removed 'Phasedate' parameter from finders, to standardize with other API finders.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Removed Finders | selectCostCatCodes: phaseDate, selectByphaseDate: phaseDate | GET | 22 | Nov. 15, 2025 | PCI Detail |
Core System
Endpoint: sys-rest-api/jersey/v1/users?compCode={compCode}&createDate={createDate}&empNo={empNo}&userId={userId}
Notes: Removed attributes on the DB functional layer and added attributes partner type and permission template.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Removed Attributes | items[i]: partnerType, permissionTemplate | GET | Nexus 1 (23) | May 16, 2026 | Retrieve Users By Company Code, User ID, Employee No and Created Date |
Endpoint: sys-rest-api/rest/1/sduser
Notes: API depreciated.
| Version | Change | Description | Method | Standard Patch | Cloud Release Date | Reference |
|---|---|---|---|---|---|---|
| 1 | Depreciated | Replaced with API User. | All | 22 | Nov. 15, 2025 | User |