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

Accounts Payable

AP Registered Invoices

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

Asset Management

Inventory

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 24 November 2026 Inventory Item

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 Standard Patch Cloud Release Date Reference
All Error Messages Standard http codes and error messages ALL 23 Q2 2026 Best Practice - Global API Exception Handling

Human Capital Management


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 Standard Patch Cloud Release Date Reference
1 Corrected View Added syscontext GET 21 May 31, 2025 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 Standard Patch Cloud Release Date Reference
1 Modified finder attributes loczipcodestart, loczipcodeend GET 21 May 31, 2025 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 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

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 Standard Patch Cloud Release Date Reference
1 Removed Attribute GjcatCompName, GjcatJobName GET 22 Nov. 15, 2025 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 Standard Patch Cloud Release Date Reference
1 Removed Finders selectCostCatCodes: phaseDate, selectByphaseDate: phaseDate GET 22 Nov. 15, 2025 PCI Detail

Core System

System User

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
Copyright © 2024 CMiC All Rights Reserved