HighLevel: Schedule an schedule invoice

← Invoices operations · Get started

Operation gohighlevel.schedule_invoice_schedule

Provider route: POST /invoices/schedule/{scheduleId}/schedule. 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"]["scheduleInvoiceSchedule"]>[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.scheduleInvoiceSchedule(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.schedule_invoice_schedule(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.scheduleId	string	Required within parent
body	Model	Required within parent	Expand Schedule an schedule invoice — request body — body

Referenced models: Schedule an schedule 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 Get an schedule — response body

Referenced models: Get an schedule — response body

Schemas

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

Get an schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Schedule 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
compiledTermsNotes	string	Required within parent	Compiled terms notes
contactDetails	JSON	Required within parent	Contact Details
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact 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
invoices	array	Required within parent	List of invoices
invoices[]	Model	Each item	Expand Void invoice — response body
items	array	Required within parent	Invoice Items
items[]	string	Each item
liveMode	boolean	Required within parent	Live Mode
name	string	Required within parent	Name of the invoice
schedule	Model	Optional	Expand Get an schedule — response body — schedule
status	object	Required within parent	Schedule Status
termsNotes	string	Required within parent	Terms notes
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

Referenced models: Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Void invoice — response body, Send Estimate — response body — discount / type: percentage, fixed, Get an schedule — response body — schedule

Schedule an schedule 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
autoPayment	JSON	Optional	auto-payment configuration
autoPayment (allOf 1)	Model	All variants apply	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account
liveMode	boolean	Required within parent

Referenced models: Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account

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

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

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

Update invoice — request body — body contact Details additional Emails item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent

Policy, approvals and errors

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

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

Official provider source