HighLevel: List invoices

← Invoices operations · Get started

Operation gohighlevel.invoices_list_invoices

Provider route: GET /invoices/. 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"]["listInvoices"]>[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.listInvoices(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.list_invoices(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.altId	string	Required within parent
query.altType	string	Required within parent	One of: location
query.status	string	Optional
query.startAt	string	Optional
query.endAt	string	Optional
query.search	string	Optional
query.paymentMode	string	Optional	One of: default, live, test
query.contactId	string	Optional
query.limit	string	Required within parent
query.offset	string	Required within parent
query.sortField	string	Optional	One of: issueDate
query.sortOrder	string	Optional	One of: ascend, descend

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 List invoices — response body

Referenced models: List invoices — response body

Schemas

List invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root
invoices	array	Required within parent
invoices[]	Model	Each item	Expand Get invoice — response body
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of invoices
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get invoice — response body

Get 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
remindersConfiguration	JSON	Optional	Reminders Configuration
remindersConfiguration (allOf 1)	Model	All variants apply	Expand Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings
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]+)?$
totalSummary	Model	Required within parent	Expand Get invoice — response body — total Summary
updatedAt	string	Required within parent	updated at

Referenced models: Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings, Get invoice — response body — total Summary

Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings

Field	Type	Presence	Description and constraints
$	object	Root
reminderExecutionDetailsList	JSON	Required within parent	List of reminders
reminderExecutionDetailsList (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
reminderSettings	JSON	Required within parent	Reminder settings
reminderSettings (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Referenced models: Delete Event — request body — body, Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Get invoice — response body — total Summary

Field	Type	Presence	Description and constraints
$	object	Root
discount	JSON	Required within parent
discount (anyOf 1)	number	Alternative	discount
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subTotal	JSON	Required within parent
subTotal (anyOf 1)	number	Alternative	subTotal
subTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax	JSON	Required within parent
tax (anyOf 1)	number	Alternative	tax
tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Delete Event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root

Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Field	Type	Presence	Description and constraints
$	object	Root
defaultEmailTemplateId	string	Required within parent	default template Id of reminder
reminders	array	Required within parent	List of reminders
reminders[]	Model	Each item	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Referenced models: Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Field	Type	Presence	Description and constraints
$	object	Root
emailSubject	string	Required within parent	Subject of the reminder
emailTemplate	string	Required within parent	Email template to be used for sending reminders
enabled	boolean	Required within parent	Flag indicating if the reminder is enabled or not
endTime	string	Optional	Business Hour End Time
intervalType	string	Required within parent	Interval type for the reminder Known values: yearly, monthly, weekly, daily, hourly, minutely, secondly
maxReminders	JSON	Required within parent
maxReminders (anyOf 1)	number	Alternative	Maximum number of reminders that can be sent
maxReminders (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reminderId	string	Required within parent	Unique identifier for the reminder
reminderInvoiceCondition	string	Required within parent	Condition for sending the reminder Known values: invoice_sent, invoice_overdue
reminderName	string	Required within parent	Name of the reminder
reminderNumber	JSON	Required within parent
reminderNumber (anyOf 1)	number	Alternative	frequency gap of the reminder to exeucte
reminderNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reminderTime	string	Required within parent	Time condition for the reminder Known values: before, after
smsTemplate	string	Required within parent	SMS template to be used for sending reminders
startTime	string	Optional	Business Hour Start Time
timezone	string	Optional	Timezone at which reminder will be sent

Policy, approvals and errors

SDK function policy ID: gohighlevel.invoices_list_invoices. Catalog operation: invoices.list-invoices. 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.readonly"]

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

Official provider source