Closeout API
API Explorer The OpenAPI description for this API is available to view and download here.
The Anywhere Closeout API is used to retrieve the details for the Anywhere Closeout screens.
Prerequisites
Section titled “Prerequisites”In order to use the API the user:
- Must be permissioned in the Accubid Anywhere Manager for “API Data Access” (“Full” permission).
- Must be successfully authenticated via Trimble ID.
- Retrieve a database token from the Anywhere Database API.
Use Cases
Section titled “Use Cases”Retrieve List of Bid Breakdown Views
Section titled “Retrieve List of Bid Breakdown Views”This API allows you to get the list of Bid Breakdown Views of a specific estimate that the user has access to.
Retrieve Bid Breakdown Details
Section titled “Retrieve Bid Breakdown Details”This API allows you to get the Bid Breakdown details of specific Bid Summary and Bid Breakdown View that the user has access to.
Retrieve Final Price Details
Section titled “Retrieve Final Price Details”This API allows you to get the final price details of a specific bidsummary that the user has access to.
How-To Guides
Section titled “How-To Guides”Getting Started
Section titled “Getting Started”- Follow the below instructions regarding authorization
- Follow the instructions regarding authenticating with Trimble Identity.
- Call the database list API to return a list of database names and tokens. Note - database tokens do not change, so they can be saved for future use.
- Call the project list API to return a list of project names and IDs. Note - Project IDs do not change, so they can be saved for future use.
- Call the estimate list API to return a list of estimate names and IDs. Note - Estimate IDs do not change, so they can be saved for future use.
- Call the estimate info API to return a list of Bid Summary IDs. Note - Bid Summaries IDs do not change, so they can be saved for future use.
- Call the Bid Breakdown Views list API to return a list of Bid Breakdown View names and IDs. Note - Bid Breakdown View IDs do not change, so they can be saved for future use.
Explanation and Concepts
Section titled “Explanation and Concepts”- Database - The user requires a database token in order to use the closeout API
- Project - The user requires a project ID in order to retrieve a list of estimates (for that project)
- Estimate - The user requires an estimate ID in order to retrieve a list of bidsummaries (for that estimate)
Reference
Section titled “Reference”Dependencies
Section titled “Dependencies”- Anywhere Database API - In order to use the Closeout API you will require database tokens from the Anywhere Database API.
- Anywhere Project API - In order to use the Closeout API you will require Project IDs from the Anywhere Project API.
- Anywhere Estimate API - In order to use the Closeout API you will require Bidsummary IDs from the Anywhere Estimate API.
Error Message Table
Section titled “Error Message Table”Please see below table containing the list of currently used error codes
| Code | Description |
|---|---|
| 200 | The request was successful |
| 400 | Parameter(s) are invalid |
| 401 | Request could not be authorized |
| 403 | Request was explicitly forbidden, user does not have access to database |
| 404 | A required reference was not found |
| 409 | Conflict. Database is locked please try again later |