HighLevel: Send Estimate

← Invoices operations · Get started

Operation gohighlevel.send_estimate

Provider route: POST /invoices/estimate/{estimateId}/send. 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"]["sendEstimate"]>[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.sendEstimate(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.send_estimate(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.estimateId	string	Required within parent
body	Model	Required within parent	Expand Send Estimate — request body — body

Referenced models: Send 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

1 more schema is linked from the tables above, on the schema pages.

Send Estimate — response body

Field	Type	Presence	Description and constraints
$	object	Root
__v	JSON	Required within parent
__v (anyOf 1)	number	Alternative	Version number
__v (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
_id	string	Required within parent	Unique identifier
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
attachments	array	Optional	Attachments
attachments[]	Model	Each item	Expand Send Estimate — response body — attachments item
autoInvoice	JSON	Optional	Auto-invoice settings for the estimate
autoInvoice (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
automaticTaxesCalculated	boolean	Required within parent	Indicates if automatic taxes were calculated
automaticTaxesEnabled	boolean	Required within parent	Indicates if automatic taxes are enabled for this estimate
businessDetails	JSON	Required within parent	Business details associated with the estimate
businessDetails (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
companyId	string	Required within parent	Company identifier associated with the estimate
contactDetails	JSON	Required within parent	Contact details for the estimate
contactDetails (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
createdAt	string	Required within parent	Timestamp when created Format: date-time
currency	string	Required within parent	Currency code
deleted	boolean	Required within parent	Indicates if deleted
discount	JSON	Required within parent	Discount details for the estimate template
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
estimateActionHistory	array	Required within parent	History of actions taken on the estimate
estimateActionHistory[]	string	Each item
estimateNumberPrefix	string	Optional	Estimate number prefix
expiryDate	string	Required within parent	Date when the estimate expires Format: date-time
frequencySettings	JSON	Required within parent	Frequency settings for recurring estimates
frequencySettings (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — frequency Settings enabled, schedule
issueDate	string	Required within parent	Date when the estimate was issued Format: date-time
items	array	Required within parent	An array of items
items[]	array	Each item
lastVisitedAt	string	Required within parent	Timestamp when the estimate was last visited Format: date-time
liveMode	boolean	Required within parent	Indicates if it is in live mode
meta	object	Required within parent	Additional metadata associated with the estimate
name	string	Required within parent	Name
sentBy	string	Optional	User who sent the estimate
sentTo	JSON	Required within parent	Recipient details for the estimate
sentTo (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
termsNotes	string	Optional	Terms and conditions for the estimate, supports HTML markup
title	string	Optional	Title
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalamountInUSD	JSON	Required within parent
totalamountInUSD (anyOf 1)	number	Alternative	Total amount in USD
totalamountInUSD (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent	Trace ID for logging and debugging
updatedAt	string	Required within parent	Timestamp when last updated Format: date-time
updatedBy	string	Optional	User Id of who last updated

Referenced models: Delete Event — request body — body, Send Estimate — response body — attachments item, Send Estimate — response body — frequency Settings enabled, schedule, Send Estimate — response body — discount / type: percentage, fixed

Send Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: sms_and_email, send_manually, email, sms
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
estimateName	string	Optional	estimate name
liveMode	boolean	Required within parent	livemode for estimate
sentFrom	JSON	Optional	sender details for invoice, valid only if invoice is not sent manually
sentFrom (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — sender Configuration from Email, from Name
userId	string	Required within parent	Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.

Referenced models: Get Invoice Settings — response body — sender Configuration from Email, from Name

Delete Event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root

Send Estimate — response 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	JSON	Required within parent
size (anyOf 1)	number	Alternative	Size of the file
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Type of the file
url	string	Required within parent	URL of the file

Send Estimate — response body — frequency Settings enabled, schedule

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	enabled for the frequency settings
schedule	JSON	Required within parent	schedule setting for the estimate
schedule (allOf 1)	Model	All variants apply	Expand Get an schedule — response body — schedule

Referenced models: Get an schedule — response body — schedule

Send Estimate — response body — discount / type: percentage, fixed

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Discount type Known values: percentage, fixed Default: percentage
validOnProductIds	array	Optional	Product Ids on which discount is applicable
validOnProductIds[]	string	Each item
value	JSON	Optional
value (anyOf 1)	number	Alternative	Discount Value Default: 0
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Invoice Settings — response body — sender Configuration from Email, from Name

Field	Type	Presence	Description and constraints
$	object	Root
fromEmail	string	Optional	Email id to be used while sending email notification
fromName	string	Optional	Sender name to be used while sending email notification

Get an schedule — response body — schedule

Field	Type	Presence	Description and constraints
$	object	Root
executeAt	string	Optional
rrule	Model	Optional	Expand Get an schedule — response body — schedule rrule

Referenced models: Get an schedule — response body — schedule rrule

Policy, approvals and errors

SDK function policy ID: gohighlevel.send_estimate. Catalog operation: send-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