Getting StartedAPI Reference
API Reference

Executes the Add Line action for the Contracts data object.

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

Adds a new line to 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
integer
required
1 to 255

Key to jc/contracts(JCCo, Contract).

string
required
length ≤ 10

Key to jc/contracts(JCCo, Contract).

string
required
length ≤ 16

Key to ContractItems array in jc/contracts(JCCo, Contract, Item).

string | null

Optional. If omitted, it will be defaulted based on Vista defaulting behavior.

string
length ≤ 10

Key to jc/departments(JCCo, Department). Optional. If omitted, it will default from the $.Department property of the referenced Contract.

string | null

Default TaxCode for AR and JB transactions. Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo. Optional. If omitted, the $.TaxCode will be defaulted.

string
length ≤ 3

Key to hq/unit_of_measures(UM). Optional if providing an SICode. If omitted, it will be defaulted based on the SICode.

string | null

Standard item Code. key to jc/std_item_code(SIRegion, SICode). SI Region must be set on the Contract to provide a SICode for an Item. Optional. If omitted, null will be defaulted.

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

Default RetainPCT for new subcontract line items in PM and SL. Optional. If omitted, the $.RetainagePCT will be defaulted.

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

Amount on the form. This value can differ from the OrigUnits OrigUnitPrice calculation to allow for rounded contract amounts. For example, you can provide Qty of 1000 and unit Price of 1.01 with a total of 1000. Optional. If omitted, it will be calculated as OrigUnits OrigUnitPrice.

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

Units on the form. This value will be ignored and 0 substituted if UM is LS. Optional. If omitted, 0 will be defaulted.

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

Unit Price on the form. This value will be ignored and 0 substituted if UM is LS. Optional. If omitted, it will be defaulted based on Vista defaulting behavior.

string | null
enum

Options: P-Progress, T-T&M, B-Both, N-None. Optional. If omitted, the $.DefaultBillType will be defaulted.

Allowed:
string | null

Related to records found in JB Bill Groups application Optional. Optional. If omitted, null will be defaulted.

string | null

Optional. If omitted, it will be defaulted based on Vista defaulting behavior.

string | null

Optional. If omitted, null will be defaulted.

string
enum

Set to Y if the % complete for subs should be the same as for this item. Optional. If omitted, N will be defaulted.

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

Format: YYYY-MM-01. Optional. If omitted, it will default from the $.StartMonth property of the referenced Contract.

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

Optional. If omitted, 0 will be defaulted.

string
enum

Initialize Billing amounts as 0. Only applicable to BillType P and B. Optional. If omitted, N will be defaulted.

Allowed:
__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