Executes the Add action for the Jobs data object.

post

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

Adds a new Job 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 jc/jobs(JCCo, Job).

Job

string

required

length ≤ 10

Key to jc/jobs(JCCo, Job).

Description

string | null

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

Contract

string

required

length ≤ 10

Key to jc/contracts(JCCo, Contract).

BidNumber

string | null

Optional. If omitted, null will be defaulted.

LockPhases

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

ProjectMgr

integer | null

Key to jc/project_managers(JCCo, ProjectMgr). Optional. If omitted, null will be defaulted.

JobPhone

string | null

Optional. If omitted, null will be defaulted.

JobFax

string | null

Optional. If omitted, null will be defaulted.

MailAddress

string | null

Optional. If omitted, null will be defaulted.

MailCity

string | null

Optional. If omitted, null will be defaulted.

MailState

string | null

Optional. If omitted, null will be defaulted.

MailZip

string | null

Optional. If omitted, null will be defaulted.

MailAddress2

string | null

Optional. If omitted, null will be defaulted.

ShipAddress

string | null

Optional. If omitted, null will be defaulted.

ShipCity

string | null

Optional. If omitted, null will be defaulted.

ShipState

string | null

Optional. If omitted, null will be defaulted.

ShipZip

string | null

Optional. If omitted, null will be defaulted.

ShipAddress2

string | null

Optional. If omitted, null will be defaulted.

LiabTemplate

integer

required

Key to jc/liability_templates(JCCo, LiabTemplate).

TaxCode

string | null

Key to hq/tax_codes(TaxGroup, TaxCode). TaxGroup will be determined based on JCCo. Optional. If omitted, null will be defaulted.

InsTemplate

integer | null

Key to jc/insurance_templates(JCCo, InsTemplate). If omitted, null will be defaulted.

MarkUpDiscRate

string

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

Optional. If omitted, 0 will be defaulted.

PRLocalCode

string | null

Optional. If omitted, null will be defaulted.

PRStateCode

string

required

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.

Certified

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

EEORegion

string | null

Optional. If omitted, null will be defaulted.

SMSACode

string | null

Optional. If omitted, null will be defaulted.

CraftTemplate

integer | null

Optional. If omitted, null will be defaulted.

ProjMinPct

string

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

Optional. If omitted, o will be defaulted.

Notes

string | null

Optional. If omitted, null will be defaulted.

SLCompGroup

string | null

Key to hq/compliance_groups(CompGroup). Optional. If omitted, null will be defaulted.

POCompGroup

string | null

Key to hq/compliance_groups(CompGroup). Optional. If omitted, null will be defaulted.

OTSched

integer | null

Optional. If omitted, null will be defaulted.

PriceTemplate

integer | null

Optional. If omitted, null will be defaulted.

HaulTaxOpt

integer

enum

Options:0-Not Taxable, 1-Taxable using haul vendor, 2-Always taxable. Optional. If omitted, 0 will be defaulted.

Allowed:

GeoCode

string | null

Optional. If omitted, null will be defaulted.

BaseTaxOn

string

enum

length ≤ 1

Options:J-Job, V-Vendor, O-Vendor Override. Optional. If omitted, J will be defaulted.

Allowed:

UpdatePlugs

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

AutoAddItemYN

string

enum

Auto-add contract item and update contract item amount when adding original estimates. Optional. If omitted, N will be defaulted.

Allowed:

WghtAvgOT

string

enum

Optional. If omitted, N will be defaulted.

Allowed:

HrsPerManDay

string

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

SecurityGroup

integer | null

Optional. If omitted, it will be defaulted based on Vista defaulting behavior. 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.

UpdateAPActualsYN

string

enum

Optional. If omitted, Y will be defaulted.

Allowed:

UpdateMSActualsYN

string

enum

Optional. If omitted, Y will be defaulted.

Allowed:

RateTemplate

integer | null

Key to jc/fixed_rate_templates(JCCo, RateTemplate). Optional. If omitted, null will be defaulted.

RevGrpInv

string | null

Reviewer Group for Invoices. Optional. Key to hq/reviewer_groups(ReviewerGroup). If omitted, null will be defaulted.

MailCountry

string | null

Optional. If omitted, null will be defaulted.

ShipCountry

string | null

Optional. If omitted, null will be defaulted.

CertDate

date | null

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

ApplyEscalators

string

enum

Allowed:

UseTaxYN

string

enum

Use Default tax code for subcontracts. Optional. If omitted, null will be defaulted.

Allowed:

TimesheetRevGroup

string | null

Reviewer Group for Timesheets. Key to hq/reviewer_groups(ReviewerGroup). Optional. If omitted, null will be defaulted.

ConstructionType

string | null

enum

Options:B-Building, D-Dredging, H-Heavy, R-Residential, W-Highway. Optional. If omitted, null will be defaulted.

Allowed:

PRLeaveLevel

string | null

Relates to PR Leave Levels application. Optional. If omitted, null will be defaulted.

__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

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.