HighLevel: Update invoice

← Invoices operations · Get started

Operation gohighlevel.update_invoice

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

Referenced models: Update invoice — 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 Void invoice — response body

Referenced models: Void invoice — response body

Schemas

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

Void invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Invoice Id
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
amountDue	JSON	Required within parent
amountDue (anyOf 1)	number	Alternative	Total Amount Due
amountDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountPaid	JSON	Required within parent
amountPaid (anyOf 1)	number	Alternative	Amount Paid
amountPaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
automaticTaxesCalculated	boolean	Optional	Is Automatic taxes calculated for the Invoice items
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	object	Required within parent	Business Details
contactDetails	object	Required within parent	Contact Details
createdAt	string	Required within parent	created at
currency	string	Required within parent	Currency
discount	object	Optional	Discount
dueDate	string	Required within parent	Due date in YYYY-MM-DD format
invoiceItems	array	Required within parent	Invoice Items
invoiceItems[]	string	Each item
invoiceNumber	JSON	Required within parent
invoiceNumber (anyOf 1)	number	Alternative	Invoice Number
invoiceNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
liveMode	boolean	Required within parent	Live Mode
name	string	Required within parent	Name of the invoice
paymentSchedule	object	Optional	split invoice into payment schedule summing up to full invoice amount
status	string	Required within parent	Invoice Status Known values: draft, sent, payment_processing, paid, void, partially_paid
title	string	Required within parent	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]+)?$
updatedAt	string	Required within parent	updated at

Update invoice — 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
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	JSON	Optional	Business details which need to be updated
businessDetails (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body business Details
contactDetails	Model	Optional	Expand Update invoice — request body — body contact Details
contactId	string	Optional	Id of the contact which you need to send the invoice
currency	string	Required within parent	Currency
description	string	Optional	Description
discount	Model	Optional	Expand Create & Send — request body — body discount
dueDate	string	Required within parent	Due date in YYYY-MM-DD format
invoiceItems	array	Required within parent
invoiceItems[]	Model	Each item	Expand Create & Send — request body — body items item
invoiceNumber	string	Optional	Invoice Number
invoiceNumberPrefix	string	Optional	prefix for invoice number
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
liveMode	boolean	Optional	Payment mode
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 to be updated
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
paymentSchedule	JSON	Optional	split invoice into payment schedule summing up to full invoice amount
paymentSchedule (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / paymentSchedule / type: fixed, percentage
termsNotes	string	Optional	Terms notes, Also supports HTML markups
tipsConfiguration	JSON	Optional	tips configuration for the invoice
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Title for the invoice
xeroDetails	object	Optional

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body / paymentSchedule / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

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

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

Policy, approvals and errors

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

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

Official provider source