Create Contract (V3)

Create a new Contract. The work breakdown structure supports three levels: WBS1 items may nest WBS2 items, which may nest WBS3 items. WBS2 and WBS3 items inherit the cost code and the project site of their WBS1 item, and the value of an item that has children must equal the sum of their values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255
string
required
length ≤ 36

Project id

string | null
required

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

string | null
required

Client contact id - when create your contract with the client

string
enum
required

Contract type - currently only standard contracts are supported via the public API

Allowed:
string
enum
required
Allowed:
wbs1
array of objects
required

Work breakdown structure of the contract. WBS1 items may nest WBS2 items, which in turn may nest WBS3 items.

wbs1*
string | null
enum
required

Defines how the Owner's Rep contracts with the Owner and who holds the vendor contracts. Advisory: Rep advises the Owner; the Owner holds all vendor contracts (Owner budget). Agency (Non-Bill Pay): Rep acts as agent for the Owner; the Owner holds vendor contracts; Rep does not handle vendor payments (Owner budget). Agency (Bill Pay): Rep acts as agent for the Owner; the Owner holds vendor contracts; Rep processes vendor payments (Owner budget). Principal – Fixed Fee Delivery: Rep holds all vendor contracts directly; the Main Contract with the Owner covers the full project scope; Your budget is used (primarily for closed-book arrangements). Principal – Transparent Billing: Rep holds all vendor contracts directly; the Main Contract with the Owner covers only Rep fees; full cost detail is shared with the Owner; Your budget is used (primarily for open-book arrangements).

Allowed:
string | null
enum
required
Allowed:
date | null
Defaults to null
date | null
Defaults to null
additional_attachment_ids
array of strings
Defaults to []

IDs of additional attachment files

additional_attachment_ids
string | null
Defaults to null
string | null
Defaults to null
string | null
Defaults to null
Responses

400

Bad Request

401

Unauthorized

422

Bad request parameters

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json