Try our GraphQL Playground
We've included some static documentation below, however GraphQL APIs are traditionally represented through interactive playgrounds. Hover GraphQL Playground
In addition to measurements, Hover enables the generation of estimates, proposals, signed proposals, and orders based on a property's measurement data. Hover's Exterior Home Improvement (EHI) API endpoints allow contractors to leverage Hover measurement information to generate estimates for exterior home retail and/or restoration repairs or upgrades. Hover's estimating tools are tailored to contractors' needs and preferences, ensuring the generated estimates provide accurate outputs for proposals, signed proposals, and Material/Work Orders.
Estimation APIs require a Hover Transform plan
Access to Hover's estimation tools through this API requires users to be on the Transform plan. More information about Hover's pricing plans can be found at https://hover.to/pricing.
Definitions
Estimate Group
An Estimate Group is generated when a Hover user completes their custom estimation process within the Hover platform. An individual estimate is created for each selected trade template during this process. The collection of these estimates is called the Estimate Group. Each Estimate Group can include one or more estimates associated with multiple templates and trades.
Active Estimate
Once an Estimate Group is generated, a Hover user can select one estimate per trade type to be designated as active for a specific project. Only one estimate per trade can be active at any given time for that project. The "active" status of a selected estimate can be updated by the contractor as needed.
Sales Opportunity
A Sales Opportunity is a collection of active estimates within an estimate group. After a Hover user has selected the active estimates (the chosen estimate for each trade type to be included in the project) for a homeowner, they can create a proposal document for signing and mark the job as "sold." Once a job is marked as "sold," a sold estimate group is created, and a Production List is generated. Only one estimate can be marked as sold for a given job, at which point all estimate values are frozen to represent the agreed-upon "sale."
Production List
A Production List is generated once an estimate group is marked as "sold." The production list is accessible only to Admin user types (e.g., a production or operations administrator for a roofing/siding contractor). This list is used to manage the job's lifecycle post-sale and includes the following:
- Order Management: Material order summaries and work orders required for the project. Orders can be placed with third-party vendors. Once an order is placed, all associated list items become available.
- Job financials: The contracted ("sold") job costs versus the actual job costs, as well as overall job profitability.