The Cost Estimates API is designed to access Cost Estimates documents through the Documents API. The Assignment Package configuration allowed pre-configuration of Cost Estimate reports, making them available in the documents table after running the Assignment Package.
API Subscribers can be able to use the API to perform a calculation and/or generate a report on an existing Cost Estimate using the report configuration made in a Cost Estimates template.
Security Role Access
The user's role who wishes to configure the API Automation Configuration tab in the Cost Estimate Template screen must have the appropriate access rights to the 'Cost Estimate Template - API Automation Configuration':
Configuration
The endpoint associated with this feature lets the user calculate and process reporting to an existing CE. It can be specified whether to calculate and/or generate a report from an existing CE by setting a flag within their request. Regenerating the CE, all previous documents associated with the CE ID will be deleted, including user-uploaded documents. For more information check the Cost Estimates API - Overview section.
Reports will automatically be generated when executing Cost Estimate Process Batches, which can be requested through Cost Estimate API. API Automation Configuration Reports will not be generated for What-If Cost Estimates (only Associated What-If Cost Estimates will be generated).
To begin the pre-configuration of reports for the Cost Estimate API, click
button. It is possible to add multiple reports at the template level.
Select the Product Report from the list that you intended to run. The list of Production Reports depends on the setup of the Production Report category, which must be 'Cost Estimate Report.'
In order for the Report can interact with External Users, the 'API Subscriber' must be added on the External User Type Access grid. Similarly, Cost Estimate page must be added to the Screen Report Header Availability grid.
After selecting the Production Report, the Parameters will also be loaded.
The Output Type can be either PDF or Excel format.
Note - API subscriber cannot run a Cost Estimate report for WICE and an API subscriber cannot run a WICE report for a Cost Estimate.
Documents created from the Cost Estimate will be made available on the Assignment Document page and Assignment CE page.