Getting StartedAPI Reference
API Reference

Executes the Change action for the Jobs data object.

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

Changes an existing Job 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
string
length ≤ 10

Key to jc/contracts(JCCo, Contract).

string | null
string
enum
Allowed:
integer | null

Key to jc/project_managers(JCCo, ProjectMgr).

string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
integer

Key to jc/liability_templates(JCCo, LiabTemplate).

string | null

Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo.

integer | null

Key to jc/insurance_templates(JCCo, InsTemplate).

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

Used in the payroll process to lookup pr/states(PRCo, PRStateCode). This value does not have to exist in pr/states to save this record.

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

Key to hq/compliance_groups(CompGroup).

string | null

Key to hq/compliance_groups(CompGroup).

integer | null
integer | null
integer
enum

Options:0-Not Taxable, 1-Taxable using haul vendor, 2-Always taxable.

Allowed:
string | null
string
enum
length ≤ 1

Options:J-Job, V-Vendor, O-Vendor Override.

Allowed:
string
enum
Allowed:
string
enum

Auto-add contract item and update contract item amount when adding original estimates.

Allowed:
string
enum
Allowed:
string
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
integer | null

If this record is updated to a security group that is not authorized for the API user, you will not see the record in the cache.

string
enum
Allowed:
string
enum
Allowed:
integer | null
string | null

Reviewer Group for Invoices. Optional. Key to hq/reviewer_groups(ReviewerGroup).

string | null
string | null
date | null

Format: YYYY-MM-DD.

string
enum
Allowed:
string
enum

Use Default tax code for subcontracts.

Allowed:
string | null

Reviewer Group for Timesheets. Key to hq/reviewer_groups(ReviewerGroup).

string | null
enum

Options:B-Building, D-Dredging, H-Heavy, R-Residential, W-Highway.

Allowed:
string | null

Relates to PR Leave Levels application.

__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