Getting StartedAPI Reference
API Reference

Executes the Add action for the Contract Items data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/jc/2/data/contract_items/actions/add

Adds a new JC contract item (schedule of values / bid item line) on an existing contract.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params

Schema for adding a new JC contract item record.

integer
required
1 to 255

Job Cost company.

string
required
length ≤ 10

Contract ID. Key to jc/contract_headers(JCCo, Contract).

string
required
length ≤ 16

Contract item ID.

string | null

Contract item description.

string
required
length ≤ 10

Department.

integer | null

Tax group.

string | null

Tax code.

string
required
length ≤ 3

Unit of measure.

string | null

SI region.

string | null

SI code.

string
required
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Retainage percent.

string
required
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Original contract amount.

string
required
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

Original contract units.

string
required
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Original unit price.

string
required
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Current contract amount.

string
required
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

Current contract units.

string
required
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Current unit price.

string | null

Bill type (Progress, T&M, Both, None).

string | null

Bill group.

string | null

Bill description.

string
required
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

Bill original units.

string
required
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Bill original amount.

string
required
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Bill unit price.

string | null

Notes.

string
enum
required

Initialize subcontracts flag.

Allowed:
string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Unique attachment identifier.

date
required

Contract item start month. Format: YYYY-MM-01.

string
required
^[-+]?[0-9]{1,2}(?:.[0-9]{0,6})?$

Markup rate for T&M billing.

string | null

Projection notes.

string
enum
required

Projection plug flag.

Allowed:
string
enum
required

Initialize as zero flag.

Allowed:
__custom_fields
object

Vista custom fields defined for JCCI in Vista.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated about 1 month ago

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

Updated about 1 month ago