HighLevel: Update template

← Invoices operations · Get started

Operation gohighlevel.update_invoice_template

Provider route: PUT /invoices/template/{templateId}. 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"]["updateInvoiceTemplate"]>[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.updateInvoiceTemplate(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.update_invoice_template(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.templateId	string	Required within parent
body	Model	Required within parent	Expand Update template — request body — body

Referenced models: Update template — 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 Create template — response body

Referenced models: Create template — response body

Schemas

Create template — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Template Id
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
businessDetails	JSON	Required within parent	Business Details
businessDetails (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body business Details
createdAt	string	Required within parent	created at
currency	string	Required within parent	Currency
discount	JSON	Optional	Discount
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
invoiceNumberPrefix	string	Optional	prefix for invoice number
items	array	Required within parent	Invoice Items
items[]	string	Each item
name	string	Required within parent	Name of the Template
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]+)?$
updatedAt	string	Required within parent	updated at

Referenced models: Create & Send — request body — body business Details, Send Estimate — response body — discount / type: percentage, fixed

Update template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
currency	string	Required within parent
discount	Model	Optional	Expand Create & Send — request body — body discount
internal	boolean	Optional
items	array	Required within parent
items[]	Model	Each item	Expand Create & Send — request body — body items item
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
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	Name of the template
termsNotes	string	Optional
title	string	Optional	Template title

Referenced models: Create & Send — request body — body business Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

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

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]+)?$

Create & Send — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Product amount
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

Create & Send — request body — body discount

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Discount type Default: percentage One of: percentage, fixed
validOnProductIds	array	Optional	Product Ids on which discount is applicable
validOnProductIds[]	string	Each item
value	number	Optional	Discount Value Default: 0

Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Field	Type	Presence	Description and constraints
$	object	Root
charges	array	Required within parent	charges for the processing fee
charges[]	array	Each item
collectedMiscellaneousCharges	number	Optional	collected miscellaneous charges
paidCharges	array	Optional	paid miscellaneous charges
paidCharges[]	Model	Each item	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Referenced models: Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Update invoice — request body — body contact Details address

Field	Type	Presence	Description and constraints
$	object	Root
addressLine1	string	Optional	Address Line 1
addressLine2	string	Optional	Address Line 2
city	string	Optional	City
countryCode	string	Optional	Country Code
postalCode	string	Optional	Postal Code
state	string	Optional	State

Create & Send — request body — body items item taxes item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent
calculation	string	Optional	One of: exclusive
description	string	Optional
name	string	Required within parent
rate	number	Required within parent
taxId	string	Optional

Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	id of the processing fee
amount	number	Required within parent	amount of the processing fee
charge	number	Required within parent	charge for the processing fee
name	string	Required within parent	name of the processing fee

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_invoice_template. Catalog operation: update-invoice-template. 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/template.write"]

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

Official provider source