Gets all Contracts objects from the cache.

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

Represents data found in Viewpoint® Vista™ PM Contracts program.

Vista views: JCCM and JCCI

Path Params

subscriber_code

string

required

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

Query Params

limit

integer

Limits the number of records returned by the API, up to a maximum of 1,000. The API may return less than the limit even when more records exist. Always examine the 'next' and 'continuationToken' properties to determin if more records are available.

modifiedUTCSince

string

A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest. Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.

continuationToken

string

A URL Encoded continuationToken value from a previous GET response. When provided, the next set of results for the original GET will be returned.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

Response body

object

limit

integer

required

data

array of objects

required

data*

object

__ryvitKeys

array of strings

__ryvitKeys

__modifiedUTC

string

JCCo

integer

required

Contract

string

required

length ≤ 10

Description

string | null

Department

string

required

length ≤ 10

ContractStatus

integer

required

OriginalDays

integer

required

CurrentDays

integer

required

StartMonth

string

required

MonthClosed

string | null

ProjCloseDate

string | null

ActualCloseDate

string | null

CustGroup

integer | null

Customer

integer | null

PayTerms

string | null

TaxInterface

string

required

Y N

TaxGroup

integer | null

TaxCode

string | null

RetainagePCT

string

required

DefaultBillType

string

required

length ≤ 1

OrigContractAmt

string

required

ContractAmt

string

required

BilledAmt

string

required

ReceivedAmt

string

required

CurrentRetainAmt

string

required

InBatchMth

string | null

InUseBatchId

integer | null

Notes

string | null

SIRegion

string | null

SIMetric

string | null

Y N

ProcessGroup

string | null

BillAddress

string | null

BillAddress2

string | null

BillCity

string | null

BillState

string | null

BillZip

string | null

BillNotes

string | null

BillOnCompletionYN

string

required

Y N

CustomerReference

string | null

CompleteYN

string

required

Y N

RoundOpt

string

required

length ≤ 1

ReportRetgItemYN

string

required

Y N

ProgressFormat

string | null

TMFormat

string | null

BillGroup

string | null

BillDayOfMth

string | null

ArchitectName

string | null

ArchitectProject

string | null

ContractForDesc

string | null

StartDate

string | null

JBTemplate

string | null

JBFlatBillingAmt

string

required

JBLimitOpt

string

required

length ≤ 1

UniqueAttchID

string | null

RecType

integer | null

OverProjNotes

string | null

ClosePurgeFlag

string | null

Y N

MiscDistCode

string | null

SecurityGroup

integer | null

UpdateJCCI

string

required

Y N

KeyID

integer

required

BillCountry

string | null

PotentialProject

string | null

MaxRetgOpt

string

required

length ≤ 1

MaxRetgPct

string

required

MaxRetgAmt

string

required

InclACOinMaxYN

string

required

Y N

MaxRetgDistStyle

string

required

length ≤ 1

MarginPct

string

required

AUUseTrustAccounts

string

required

Y N

AUQualificationDate

string | null

AUCMCo

integer | null

AUCMGeneralAcct

integer | null

AUCMRetentionAcct

integer | null

AUCMDisputedAcct

integer | null

JBReviewerGroup

string | null

ReviewLevel

string | null

__custom_fields

object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Has additional fields

ContractItems

array of objects

ContractItems

object

Item

string

required

length ≤ 16

Description

string | null

Department

string

required

length ≤ 10

TaxGroup

integer | null

TaxCode

string | null

string

required

length ≤ 3

SIRegion

string | null

SICode

string | null

RetainPCT

string

required

OrigContractAmt

string

required

OrigContractUnits

string

required

OrigUnitPrice

string

required

ContractAmt

string

required

ContractUnits

string

required

UnitPrice

string

required

BilledAmt

string

required

BilledUnits

string

required

ReceivedAmt

string

required

CurrentRetainAmt

string

required

BillType

string | null

BillGroup

string | null

BillDescription

string | null

BillOriginalUnits

string

required

BillOriginalAmt

string

required

BillCurrentUnits

string

required

BillCurrentAmt

string

required

BillUnitPrice

string

required

Notes

string | null

InitSubs

string

required

Y N

UniqueAttchID

string | null

StartMonth

string

required

MarkUpRate

string

required

ProjNotes

string | null

ProjPlug

string

required

Y N

KeyID

integer

required

InitAsZero

string

required

Y N *

__custom_fields

object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Has additional fields

string

required

continuationToken

string

required

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.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/pm/2/data/contracts/cache \
3
     --header 'accept: application/json'

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

application/json

200Success

400Describes issues with the request.