Vista API Overview

The Trimble Vista™ application programming interface (API) is a bidirectional REST API that acts as a service layer for an organization’s cloud-hosted instance of Vista.

Who can use the Vista API?

All Trimble Construction One™ cloud-hosted Vista customers are eligible to purchase and use the Vista API. Since App Xchange hosts the Vista API, visit the App Xchange website and click "talk with sales", but no additional subscription to other App Xchange products is necessary.

Using the Vista API requires technical knowledge and an understanding of REST APIs. Before using the API, you should also be familiar with Vista and know how to interact with the software. See the Vista Help documentation to learn more.

What can I do with the Vista API?

The Vista API enables access to your organization’s Vista data and provides enhanced customization capabilities for integrations with Vista. While the most in demand data is accessible via the API, not all data is enabled. Request enhancements to the underlying Vista Connector here if you find any gaps: https://appxchange.trimble.com/connectors.

How is the Vista API Organized?

Designed with a logical view of the data points that exist within modules, the Vista API mirrors the folder structure of the Vista database.

The Vista API includes endpoints in the following modules:

Accounts Payable

Accounts Receivable

Cash Management

Document Management

Equipment Management

General Ledger

Headquarters

Human Resources

Inventory

Job Cost

Material Sales

Payroll

Pre-Construction

Project Management

Purchase Order

Service Management

Subcontract Ledger

User Defined Tables

Viewpoint Administration

How does the Vista API work?

See Vista API Concepts for details.

How do I get set up to use the Vista API?

See the Getting Started Guide for details.

Usage Limitations

• Rate limit. The Vista API is limited to 2,000 requests per minute. See Rate Limits for details.

• Record and volume limits.

  • Any single record 2 MB or larger will not be returned.
  • The total of all records of a given type (for example, "Employees") may not exceed 20 GB.
  • Action inputs are limited to 5 MB.

• Historical data window (configurable at onboarding). For a set of high-volume GET endpoints,
  the amount of history returned is controlled by a data window that is set when your connection is
  configured. You can choose one of the following (new endpoints may be added to this list over time):

  • Rolling last 3 months
  • Rolling last 12 months
  • A fixed start date of your choice (subject to platform performance limits)

  Rolling windows are measured from the current date and begin at the first day of the starting month.
  Only the 3-month and 12-month rolling options are available; other rolling durations (for
  example, 6, 18, or 24 months) are not supported — use a fixed start date if you need a different range.

  Endpoints that use a configurable data window:

  • AP / Invoices
  • AR / Transaction Lines
  • GL / Transactions
  • JC / Cost Details
  • JC / Cost Detail Periods
  • MS / Tickets
  • PO / PO Headers
  • PR / Time Entries
  • SL / Subcontracts

  A window set on a parent endpoint also governs its related detail (for example, a window on
  PO / PO Headers also applies to PO Lines and PO Distributions).

  DM / Attachments is also date-limited: it supports a fixed start date and can be scoped to
  specific attachment tables during onboarding.

• Endpoints with size-based alternatives. Some combined GET endpoints are not recommended (or are
  not available) because of data-record size limitations. The same data is available through smaller,
  split endpoints:

  • Instead of PO / Purchase Orders, use PO / PO Headers and PO / PO Lines (add
    PO / PO Distributions when you need job and cost distribution detail).
  • Instead of JC / Contracts, use JC / Contract Headers and JC / Contract Items.
  • Instead of SM / Service Sites, use SM / Service Site (Header Only) when you do not need the
    embedded serviceable items and contacts.
  • Instead of all UD / Table Data, specify the table name(s) you need.

• Choosing and changing resources. During onboarding you select which resources/endpoints are
  enabled and set any data windows. These can be changed later, but a change may require a change-order fee.

Not Yet Released

• AP / Invoices will gain split Invoice Headers and Invoice Lines endpoints, providing a
  smaller alternative to the combined AP / Invoices endpoint for large invoice volumes.