Getting StartedAPI Reference
API Reference

Executes the Change action for the Contract Headers data object.

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

Updates an existing JC contract header record.

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 updating an existing JC contract header record. Requires natural keys and KeyID.

integer
required
1 to 255

Job Cost company.

string
required
length ≤ 10

Contract ID.

string | null

Contract description.

string
length ≤ 10

Department.

integer

Contract status code.

integer

Original contract days.

integer

Current contract days.

date

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

date | null

Month closed. Format: YYYY-MM-01.

date | null

Projected close date. Format: YYYY-MM-DD.

date | null

Actual close date. Format: YYYY-MM-DD.

integer | null

Customer group.

integer | null

Customer number.

string | null

Payment terms.

string
enum

Tax interface flag.

Allowed:
integer | null

Tax group.

string | null

Tax code.

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

Retainage percent.

string
length ≤ 1

Default bill type.

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

Original contract amount.

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

Current contract amount.

string | null

Notes.

string | null

SI region.

string | null
enum

SI metric flag.

Allowed:
string | null

Process group.

string | null

Billing address line 1.

string | null

Billing address line 2.

string | null

Billing city.

string | null

Billing state.

string | null

Billing ZIP.

string | null

Billing country.

string | null

Billing notes.

string
enum

Bill on completion flag.

Allowed:
string | null

Customer reference.

string
enum

Contract complete flag.

Allowed:
string
length ≤ 1

Rounding option.

string
enum

Report retainage by item flag.

Allowed:
string | null

Progress billing format.

string | null

T&M billing format.

string | null

Bill group.

string | null

Bill day of month.

string | null

Architect name.

string | null

Architect project.

string | null

Contract-for description.

date | null

Contract start date. Format: YYYY-MM-DD.

string | null

JB template.

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

JB flat billing amount.

string
length ≤ 1

JB limit option.

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.

integer | null

Record type.

string | null

Over-projection notes.

string | null
enum

Close purge flag.

Allowed:
string | null

Miscellaneous distribution code.

integer | null

Security group.

string
enum

Update contract items flag.

Allowed:
string | null

Potential project reference.

string
length ≤ 1

Maximum retainage option.

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

Maximum retainage percent.

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

Maximum retainage amount.

string
enum

Include ACO in max retainage flag.

Allowed:
string
length ≤ 1

Maximum retainage distribution style.

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

Margin percent.

string
enum

Use trust accounts flag (AU).

Allowed:
date | null

AU qualification date. Format: YYYY-MM-DD.

integer | null

AU CM company.

integer | null

AU CM general account.

integer | null

AU CM retention account.

integer | null

AU CM disputed account.

string | null

JB reviewer group.

string | null

Review level.

__custom_fields
object

Vista custom fields defined for JCCM in Vista.

integer
required
≥ 1

Surrogate record identifier (JCCM KeyID).

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