HighLevel: Create New Estimate

← Invoices operations · Get started

Operation gohighlevel.create_new_estimate

Provider route: POST /invoices/estimate. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["invoices"]["createNewEstimate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.invoices.createNewEstimate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.invoices.create_new_estimate(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create New Estimate — request body — body

Referenced models: Create New Estimate — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Send Estimate — response body

Referenced models: Send Estimate — response body

Schemas

21 more schemas are linked from the tables above, on the schema pages.

Create New Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
autoInvoice	JSON	Optional	Auto invoice for the estimate
autoInvoice (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body auto Invoice direct Payments, enabled
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Estimate Default: false
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
contactDetails	JSON	Required within parent	Contact information to send the estimate to
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
currency	string	Required within parent	Currency code
discount	Model	Required within parent	Expand Create & Send — request body — body discount
estimateNumber	number	Optional	Estimate Number, if not specified will take in the next valid estimate number
estimateNumberPrefix	string	Optional	Prefix for the estimate number Default: EST-
expiryDate	string	Optional	expiry date estimate
frequencySettings	JSON	Required within parent	frequency settings for the estimate
frequencySettings (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body frequency Settings enabled, schedule
issueDate	string	Optional	issue date estimate
items	array	Required within parent	An array of items for the estimate.
items[]	Model	Each item	Expand Update Estimate — request body — body items item
liveMode	boolean	Optional	livemode for estimate Default: true
meta	object	Optional	Meta data for the estimate
miscellaneousCharges	JSON	Optional	miscellaneous charges for the estimate
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Estimate Name
paymentScheduleConfig	JSON	Optional	Payment Schedule Config for the estimate
paymentScheduleConfig (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage
sendEstimateDetails	JSON	Optional	When sending estimate directly while saving
sendEstimateDetails (allOf 1)	Model	All variants apply	Expand Send Estimate — request body — body
sentTo	JSON	Optional	Email and sent to details for the estimate
sentTo (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body sent To
termsNotes	string	Optional	Terms notes, Also supports HTML markups
title	string	Optional	Title for the estimate
userId	string	Optional	User Id

Referenced models: Create & Send — request body — body attachments item, Update Estimate — request body — body auto Invoice direct Payments, enabled, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Update Estimate — request body — body items item, Update Estimate — request body — body frequency Settings enabled, schedule, Create & Send — request body — body discount, Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Send Estimate — request body — body, Create & Send — request body — body sent To

Create & Send — request body — body attachments item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Id of the file selected
name	string	Required within parent	Name of the file
size	number	Required within parent	Size of the file
type	string	Required within parent	Type of the file
url	string	Required within parent	URL of the file

Update Estimate — request body — body auto Invoice direct Payments, enabled

Field	Type	Presence	Description and constraints
$	object	Root
directPayments	boolean	Optional	Direct Payments
enabled	boolean	Required within parent	Enable Auto Invoice

Create & Send — request body — body business Details

Field	Type	Presence	Description and constraints
$	object	Root
address	JSON	Optional	Business Address
address (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details address
customValues	array	Optional	Custom Values
customValues[]	string	Each item
logoUrl	string	Optional	Business Logo URL
name	string	Optional	Business Name
phoneNo	string	Optional	Business Phone Number
website	string	Optional	Business Website Link

Referenced models: Update invoice — request body — body contact Details address

Update invoice — request body — body contact Details

Field	Type	Presence	Description and constraints
$	object	Root
additionalEmails	array	Optional	Secondary email addresses for the contact to be saved
additionalEmails[]	Model	Each item	Expand Update invoice — request body — body contact Details additional Emails item
address	Model	Optional	Expand Update invoice — request body — body contact Details address
companyName	string	Optional	Contact Company Name
customFields	array	Optional	Custom Values
customFields[]	string	Each item
email	string	Required within parent	Contact Email
id	string	Required within parent	Contact ID
name	string	Required within parent	Contact Name
phoneNo	string	Required within parent	Contact Phone Number

Referenced models: Update invoice — request body — body contact Details additional Emails item, Update invoice — request body — body contact Details address

Update Estimate — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Product amount
attachments	array	Optional	Attachments for the line item
attachments[]	string	Each item
automaticTaxCategoryId	string	Optional	Tax category id for calculating automatic tax
currency	string	Required within parent	Currency
description	string	Optional	Invoice descriptions
isSetupFeeItem	boolean	Optional	Setupfee item, only created when 1st invoice of recurring schedule is generated
name	string	Required within parent	Invoice Item Name
priceId	string	Optional	Price Id
productId	string	Optional	Product Id
qty	number	Required within parent	Product Quantity
taxInclusive	boolean	Optional	true if item amount is tax inclusive Default: false
taxes	array	Optional	Tax
taxes[]	Model	Each item	Expand Create & Send — request body — body items item taxes item
type	string	Optional	Price type of the item One of: one_time, recurring

Referenced models: Create & Send — request body — body items item taxes item

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_new_estimate. Catalog operation: create-new-estimate. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["invoices/estimate.write"]

Pinned headers: {"Version": "v3"}

Official provider source