Create Contract Change Request V3

post

https://{subdomain}.ingenious.build/api/v3/pub/contract-change-requests

Creates a Contract Change Request inside a Contract Change Request Package. The request estimate can be provided as a flat estimate_value, as an estimation_lines breakdown, or as a wbs breakdown of WBS1 items (each with its own flat estimate or estimation lines). When wbs items are present the request estimate is the sum of their estimations; otherwise estimation_lines take precedence over estimate_value.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

package_id

string

required

length ≤ 36

The ID of the Contract Change Request Package the request is added to. The package must be in draft status and belong to the caller's workspace.

contract_id

string | null

Defaults to null

The ID of the contract the request applies to. Required unless is_non_contracted is true, in which case it must be omitted.

cost_code_id

string | null

Defaults to null

The ID of the budget cost code of a non-contracted request. Required when is_non_contracted is true.

is_non_contracted

boolean | null

Defaults to null

When true, the request is not tied to a contract and cost_code_id identifies the budget line instead.

project_site_id

string | null

Defaults to null

The ID of the project site the request applies to. Cannot be combined with wbs items.

position

integer | null

≤ 255

Defaults to null

The ordering of the request within the package.

schedule_impact_unit

string | null

enum

Defaults to null

The unit of the schedule impact of the request.

Allowed:

schedule_impact_value

integer | null

Defaults to null

The value of the schedule impact of the request.

estimate_value

string | null

Defaults to null

The flat aggregate estimate of the request. Ignored when estimation_lines or wbs are provided.

estimation_lines

array of objects | null

Defaults to null

The request-level estimate breakdown. When provided, the request estimate is the sum of the lines. Ignored when wbs is provided.

estimation_lines

wbs

array of objects | null

Defaults to null

The WBS1-item breakdown of the request. When provided, the request estimate is the sum of the items' estimations.

wbs

Responses

400

Business error (e.g. unknown package, unknown contract, referenced record not found)

401

Unauthorized

403

Missing permission to create Contract Change Requests, or no access to the project

422

Validation error

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created