Executes the Add action for the Contracts data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/pm/2/data/contracts/actions/add

Adds a new Contract record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

JCCo

integer

required

1 to 255

Key to pm/contracts(JCCo, Contract).

Contract

string

required

length ≤ 10

Key to pm/contracts(JCCo, Contract).

Description

string | null

Optional. If omitted, null will be defaulted.

Department

string

required

length ≤ 10

Key to jc/departments(JCCo, Department).

OriginalDays

integer

Optional. If omitted, 0 will be defaulted.

StartMonth

date

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

Optional. If omitted, the current accounting month will be defaulted. Format: YYYY-MM-01.

MonthClosed

date | null

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

Optional. If omitted, null will be defaulted. Format: YYYY-MM-01.

ProjCloseDate

date | null

Optional. If omitted, null will be defaulted. Format: YYYY-MM-DD.

Customer

integer | null

Key to ar/customers(CustGroup, Customer). CustGroup will be determined based on JCCo. Optional. If omitted, null will be defaulted.

PayTerms

string | null

Key to hq/payment_terms(PayTerms). Optional. If omitted, it will be defaulted based on Vista defaulting behavior.

TaxInterface

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

TaxCode

string | null

Default TaxCode for $.Items[].TaxCode. Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo. Optional. If omitted, null will be defaulted.

RetainagePCT

string

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

Default Retainage %. Optional. If omitted, 0 will be defaulted.

DefaultBillType

string

enum

length ≤ 1

Options: P-Progress, T-T&M, B-Both, N-None. Optional. If Omitted, B will be defaulted.

Allowed:

Notes

string | null

Optional. If omitted, null will be defaulted.

SIRegion

string | null

Standard Item Region. Key to jc/std_item_codes(SIRegion, SICode). Optional. If omitted, null will be defaulted.

SIMetric

string | null

enum

Use metric Units of Measure when posting. Optional. If omitted, null will be defaulted.

Allowed:

MaxRetgOpt

string

enum

length ≤ 1

Options: N-None, P-Percent of Contract, A-Maximum Amount. Optional. If omitted N will be defaulted.

Allowed:

MaxRetgPct

string

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

Ignored if $.MaxRetgOpt is not P. Optional. If Omitted, 0 will be defaulted.

MaxRetgAmt

string

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

Ignored if $.MaxRetgOpt is not A. Optional. If Omitted, 0 will be defaulted.

InclACOinMaxYN

string

enum

Ignored if $.MaxRetgOpt is not P. Optional. If Omitted, N will be defaulted.

Allowed:

MaxRetgDistStyle

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, C will be defaulted.

Allowed:

MarginPct

string

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

Optional. If omitted, 0 will be defaulted.

AUUseTrustAccounts

string

enum

Ignored if Company Country is not Australia. Optional. If omitted, N will be defaulted.

Allowed:

AUQualificationDate

date | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, null will be defaulted. Format: YYYY-MM-01.

AUCMCo

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, null will be defaulted.

AUCMGeneralAcct

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, null will be defaulted.

AUCMRetentionAcct

integer | null

Ignored if Company Country is not Australia. Required if $.AUUseTrustAccounts = Y. Optional. If omitted, null will be defaulted.

AUCMDisputedAcct

integer | null

Ignored if Company Country is not Australia. Optional. If omitted, null will be defaulted.

PotentialProject

string | null

Potential Project

BillDayOfMth

string | null

Bill Day Of Mth

JBInfo

object

Optional. If omitted, each property will default as noted.

__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.

ContractItems

array of objects

ContractItems

Headers

X-Application-Key

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.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.