You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Home > Release Notes > API Detailed Release Notes – Enhanced Code, Project, and JHA Endpoints
API Detailed Release Notes – Enhanced Code, Project, and JHA Endpoints
print icon

(Planned Release Date of 10/8/2025 - Subject to Change)

 

Cost Codes – Company-Level Querying & Pagination

·   New companyId parameter: Query cost codes at the company level (not limited to a single project).

·   Enhanced pagination: Added page parameter with 0-based indexing for efficient dataset navigation.

·   Dual query modes: Endpoints now support both projectId and companyId parameters, but only one may be used per request.

·   Response format: Will now include a pagination object

o   status

o   data array of cost codes

o   pagination object

Budget Codes – Company-Level Querying

·   New companyId parameter: Budget codes can now be queried at the company level.

·   Dual query modes: Supports both projectId and companyId with mutual exclusivity enforced.

Quantity Codes – Company-Level Querying

·   New companyId parameter: Quantity codes can now be queried at the company level.

·   Dual query modes: Supports both projectId and companyId with mutual exclusivity enforced.

Project Options – New Company-Level Query Route

·   New route addition: A new endpoint allows querying all project options across an entire company.

·   New companyId parameter: Retrieve project options for all projects within a company.

·   Response format: Will now include a pagination object:

o   status

o   data array of project options

o   pagination object

JHA Crew – Enhanced Query Flexibility & Filtering

·   Expanded query modes: The jhaCrew endpoint now supports three mutually exclusive parameters:

o   jhaId (existing): Query by specific JHA IDs.

o   projectId (new): Query all JHA crew records for a given project.

o   companyId (new): Query all JHA crew records across a company.

·   Mutual exclusivity validation: Only one of jhaId, projectId, or companyId may be provided per request.

·   New updatedAfter parameter: Filter results to include only records updated after a specified date/time.

·   Response Format : Will now include a pagination object:

o   status

o   data array of jha crew

o   pagination object

 


Business Rationale

·   Company-wide visibility: Clients no longer need to iterate through project IDs to locate changed codes, project options, or JHA crew records.

·   Performance optimization: Company-level query parameters reduce the number of required API calls by consolidating data retrieval.

·   Data volume management: Pagination (notably for cost codes and project options) prevents excessive payload sizes.

·   Filtering best practices: Use filters like updatedAfter when querying at the company level to keep result sets manageable.

·   Data consistency: Ensures accurate, consistent retrieval across organizational boundaries.


Additional API Changes Coming Soon:

Project Payclass Employee – Enhanced with payclassId

·      Enhanced PUT support: The projectPayclassEmployee endpoint now supports updating the payclassId field.


 

True Up – New Endpoint

·      New POST endpoint: A new trueUp endpoint has been created to accept a batch of true up records.

·      Purpose: True up records specify the job-to-date (JTD) costs and hours for a project budget code as of a given date.

·      Adjustment logic:

o  Riskcast creates an internal adjustment to align system values with the supplied JTD values.

o  When multiple dates are included in a single request, earlier dates are processed first, ensuring later records build on prior adjustments.

o  When submitting multiple requests with different dates, it is recommended to send earlier dates first so adjustments cascade correctly.

·      Supported operation: POST only.

Feedback
1 out of 1 found this helpful

scroll to top icon