Getting StartedAPI Reference
API Reference

Executes the Import action for the Import Estimate Headers data object.

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

Runs Vista PM Import Estimates for one ImportId using the tenant's PM Import Estimates Template, then optionally uploads to PM.

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

Input for the import action on imp_est_header. Runs Vista PM Import Estimates for one ImportId using the tenant's PM Import Estimates Template (renders the section arrays to template lines, then vspPMImportDataBulk -> vspPMImportData), and optionally uploads to PM (vspPMVFEUpload). Equivalent to PM VFE Auto Import then Upload to PM.

integer
required
1 to 255

PM company.

string
required
length ≤ 10

Vista PM project (JCJM.Job). Must already exist with a contract. Used as ProjectCode on every rendered line.

string
required
length ≤ 10

PM Import Estimates Template id (PMUT.Template) configured for the Accubid routine, e.g. ACCUBIDEST.

string
required
length ≤ 10

Import id. Re-using an existing ImportId replaces that import's work tables (Vista behaviour in vspPMImportDataBulk).

number | null

Default retainage percent applied by the template. Default 0.

string
enum

Y = upload to PM immediately when the work tables have no errors. N = stop after import; a user finishes in PM Import Estimates, Edit Work Tables. Default N.

Allowed:
string
enum

Y = keep work tables after a successful upload. N = delete them (bspPMImportIdDelete). Default Y.

Allowed:
string | null

Description for the estimate (6) record; lands in PMWH.Description.

ContractItems
array of objects

Rendered as record type 1 lines.

ContractItems
Phases
array of objects

Rendered as record type 2 lines.

Phases
CostTypes
array of objects

Rendered as record type 3 lines.

CostTypes
Subcontracts
array of objects

Rendered as record type 4 lines.

Subcontracts
Lines
array of strings | null

Escape hatch: raw delimited import-file lines in the template's format. When non-empty, the section arrays are ignored and these lines are imported verbatim.

Lines
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