Create Contract

post

https://{subdomain}.ingenious.build/api/v2/pub/contracts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

vendor_contact_id

string | null

Vendor contact id - when create vendor contract, you are the client

client_contact_id

string | null

Client contact id - when create your contract with the client

contract_type

string

enum

Contract type - select between gmp or standard contract

Allowed:

project_id

string

required

Project id

status

string

enum

required

Allowed:

contract_holder

string | null

enum

Contract holder - There are at least 3 different ways that an Owner's Rep can contract with an Owner:
Advisory: Rep advises the Owner, but the Owner owns the contracts with vendors.
Agency: Rep represents the Owner, but the Owner owns the contracts with vendors.
Principal: Rep has full autonomy with the vendors.

Allowed:

agreement_type

string | null

enum

Allowed:

initiation_date

string

required

effective_date

string

required

document_ids

array of strings | null

IDs of the contract agreement files, shown as the Original Agreement in the contract documents

document_ids

execution_note

string | null

Note recorded on the contract's execution approval. It is shown as the approval note in the contract's approvals panel, is visible only to your workspace, and is not a contract document. Allowed only when status is executed.

execution_documents

array of strings | null

IDs of files attached to the contract's execution approval. They are shown as approval documents in the contract's approvals panel, are visible only to your workspace, and are not listed among the contract documents; send the contract agreement in document_ids instead. Allowed only when status is executed.

execution_documents

additional_attachment_ids

array of strings | null

IDs of additional attachment files

additional_attachment_ids

custom_id

string | null

wbs1

array of objects

wbs1

accounting_company_id

string | null

payment_term_id

string | null

retention

number | null

0 to 100

Defaults to 0

Retention percentage with up to two decimal places (null or omitted means 0), applied to the contract rules and to every WBS line

Headers

AccessToken

string

required

Responses

400

Bad Request

401

Unauthorized

422

Bad request parameters

Language

URL

Loading…

Response

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

application/json

201ID of created contract