Getting StartedAPI Reference
API Reference

Executes the Add action for the Subcontracts data object.

post
https://{apiHost}/connect/v1/direct/subscribers//vista/pm/2/data/subcontracts/actions/add

Adds a PM non-interfaced subcontract item on a project.

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

Schema for adding a PM non-interfaced subcontract item on a project.

integer
required
1 to 255

PM company. Key to pm/projects(PMCo, Project).

string
required
length ≤ 10

PM project.

integer | null

Subcontract company. Required when creating against an existing subcontract header.

string | null

Subcontract number. Required when adding to an existing subcontract header. If value is left empty, the record won't be inserted to the cache.

integer | null

Phase group for the subcontract item.

string
required
length ≤ 20

Phase for the subcontract item.

integer
required

Cost type for the subcontract item.

integer
required

Vendor group.

integer
required

Vendor number.

string | null

Subcontract item description.

integer
enum

Subcontract item type. 1 = Regular, 2 = Change Order, 3 = Backcharge, 4 = Add-on.

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

Number of units for the subcontract item.

string
required
length ≤ 3

Unit of measure.

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

Unit cost for the subcontract item.

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

Subcontract item amount.

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

Work-complete retainage percent.

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

Stored-material retainage percent.

string
enum
required

Y when the subcontract item is ready to interface.

Allowed:
string | null

Subcontract item notes.

integer | null

Tax group.

string | null

Tax code.

integer | null

Tax type.

string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Attachment group ID.

__custom_fields
object

Vista custom fields defined for the PM subcontract item object in Vista.

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 3 hours ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago