Explanation and Concepts

Getting Started

The endpoints are grouped together by module. Each module and its endpoints are further described to help developers understand their usage. Each endpoint also includes a mock response example and response schema.

Before You Start

There is no special set-up required to use the Trimble Unity Construct API; however, the instance should be fully configured and must be in use with API enabled for your account. Access to the API is granted by account administrators. Once your account is enabled for API Access, and you are granted an API Access Key, you can use the API for transactional integrations subject to the Trimble Unity API Acceptable Use Policy.

An API user is required to be created to use the APIs. This user should not be an individual user but should be a system user created specifically for API access. An API user is expected to have full administrative permissions to interact with the APIs effectively, and therefore should not be an individual user.

Transactional Alignment: Use cases must be limited to facilitating specific, user-initiated actions or real-time data synchronization between Trimble Unity and authorized third-party systems.

Unity Construct Primary Entity Descriptions

Account Codes: Codes used to categorize the costs on all projects to consistently associate costs with specific categories and easily report on these costs

Budgets: The original detailed cost estimate for your project

Commitments: A promise that you make to a seller to purchase goods or services in exchange for money in accordance with specific terms and conditions, most commonly representing contracts and purchase orders

Commitment Invoices: An actual cost associated with an existing commitment, such as a request for payment from a vendor that you have a contract with

Companies: A record of contact information (such as phone number, fax, email address, street address, etc.) for a company, which can be associated with commitments, costs, or bids

Contacts: A record of contact information (such as phone number, fax, email address, street address, etc.) associated with a Trimble Unity Construct Company

Documents: Project files stored in a document repository where you can control who can submit, edit, delete, or view the documents in each folder

Funding Sources: The accounts or institutions from which project funds are received, such as debt, equity, grants, and donations

General Invoices: An actual cost that does not have an associated commitment, such as a fee paid to the city for a permit

Master Commitments: Contracts that span more than one Trimble Unity Construct project, typically set up to handle a program manager, architectural/engineering firm, or job order contractor engaged by an owner to provide services on more than one project

Master Invoices: Billing invoices used to submit billing against master commitments

Processes: The automation of a business process (entirely or partially) during which documents and other pertinent information is passed from one participant to another for action, according to a set of procedural or business rules

Projects: The core container for the application where most everything in Trimble Unity Construct takes place, representing a real-world project your organization is participating in