Getting StartedAPI Reference
API Reference

Executes the Change action for the Contracts data object.

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

Changes header details for an existing Contract 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
__key
required
string | null

Optional. If omitted, existing value in Vista will remain unchanged.

string
length ≤ 10

Key to jc/departments(JCCo, Department). Optional. If omitted, existing value in Vista will remain unchanged.

integer
enum

Options: 1-Open, 2-Soft Closed, 3-Hard Closed. Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
integer

Optional. If omitted, existing value in Vista will remain unchanged.

date
^([0-9]{4})-(1[0-2]|0[1-9])-01$

Optional. If omitted, existing value in Vista will remain unchanged. Format: YYYY-MM-01.

date | null
^([0-9]{4})-(1[0-2]|0[1-9])-01$

Optional. If omitted, existing value in Vista will remain unchanged. Format: YYYY-MM-01.

date | null

Optional. If omitted, existing value in Vista will remain unchanged. Format: YYYY-MM-DD.

integer | null

Key to ar/customers(CustGroup, Customer). CustGroup will be determined based on JCCo. Optional. If omitted, existing value in Vista will remain unchanged.

string | null

Key to hq/payment_terms(PayTerms). Optional. If omitted, existing value in Vista will remain unchanged.

string
enum

Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
string | null

Default TaxCode for $.Items[].TaxCode. Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo. Optional. If omitted, existing value in Vista will remain unchanged.

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

Default Retainage %. Optional. If omitted, existing value in Vista will remain unchanged.

string
enum
length ≤ 1

Options: P-Progress, T-T&M, B-Both, N-None. Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
string | null

Optional. If omitted, null will be defaulted.

string | null

Standard Item Region. Key to jc/std_item_codes(SIRegion, SICode). Optional. If omitted, existing value in Vista will remain unchanged.

string | null
enum

Use metric Units of Measure when posting. Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
integer | null

Optional. If omitted, existing value in Vista will remain unchanged. If this record is created in a security group that is not authorized for the API user, you will not see the record in the cache after it is created.

string
enum
length ≤ 1

Options: N-None, P-Percent of Contract, A-Maximum Amount. Optional. If omitted, existing value in Vista will remain unchanged.

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

Ignored if $.MaxRetgOpt is not P. Optional. If omitted, existing value in Vista will remain unchanged.

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

Ignored if $.MaxRetgOpt is not A. Optional. If omitted, existing value in Vista will remain unchanged.

string
enum

Ignored if $.MaxRetgOpt is not P. Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
string
enum
length ≤ 1

Options:C-Composite Percentage same on all Items, I-Use Items's Percentage value from bill. Ignored if $.MaxRetgOpt is N. Optional. If omitted, existing value in Vista will remain unchanged.

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

Optional. If omitted, existing value in Vista will remain unchanged.

string
enum

Ignored if Company Country is not Australia. Optional. If omitted, existing value in Vista will remain unchanged.

Allowed:
date | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, existing value in Vista will remain unchanged. Format: YYYY-MM-01.

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, existing value in Vista will remain unchanged.

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, existing value in Vista will remain unchanged.

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, existing value in Vista will remain unchanged.

integer | null

Ignored if Company Country is not Australia. Optional. If omitted, existing value in Vista will remain unchanged.

JBInfo
object

Optional. If omitted, existing value in Vista will remain unchanged.

__custom_fields
object

Add a property to this object for each user defined field to be set. Property name set to the user defined field name.

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