HighLevel: Get Invoice Settings

HighLevel invoices.getInvoiceSettings: arguments, response, policy and SDK examples.

Operation gohighlevel.get_invoice_settings

Provider route: GET /invoices/settings. 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"]["getInvoiceSettings"]>[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.getInvoiceSettings(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.get_invoice_settings(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

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 Invoice Settings — response body

Referenced models: Get Invoice Settings — response body

Schemas

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

Get Invoice Settings — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`altId`	string	Optional	Sub-Account Id
`altType`	string	Optional	Alt Type Known values: location
`businessDetails`	JSON	Optional	Business details
`businessDetails (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website
`customFields`	array	Optional	Custom fields array Maximum items: 3
`customFields[]`	string	Each item
`customNotification`	JSON	Optional	Custom notification settings
`customNotification (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed
`dueAfterXDays`	JSON	Optional
`dueAfterXDays (anyOf 1)`	number	Alternative	Number of days after which invoice is due
`dueAfterXDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`estimateNumberPrefix`	string	Optional	Prefix for estimate numbers Maximum length: 10
`estimatesExpireAfterXDays`	JSON	Optional
`estimatesExpireAfterXDays (anyOf 1)`	number	Alternative	Number of days after which estimate expires
`estimatesExpireAfterXDays (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`estimatesTermsNote`	string	Optional	Terms and conditions for estimates
`estimatesTitle`	string	Optional	Title for estimates Maximum length: 40
`invoiceNumberPrefix`	string	Optional	Prefix for invoice numbers Maximum length: 10
`lateFeesConfiguration`	JSON	Optional	Late fees configuration
`lateFeesConfiguration (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage
`minimumPercentagePartialPayment`	JSON	Optional
`minimumPercentagePartialPayment (anyOf 1)`	number	Alternative	Minimum percentage for partial payment
`minimumPercentagePartialPayment (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`paymentMethods`	JSON	Optional	Payment methods configuration
`paymentMethods (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
`productSettings`	JSON	Optional	Product settings
`productSettings (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — product Settings description Optional, enable Import Product Description
`reminderSettings`	JSON	Optional	Reminder settings
`reminderSettings (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders
`senderConfiguration`	JSON	Optional	Sender configuration
`senderConfiguration (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — sender Configuration from Email, from Name
`termsNote`	string	Optional	Terms and conditions for invoices
`tipsConfiguration`	JSON	Optional	Tips configuration
`tipsConfiguration (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
`title`	string	Optional	Title for invoices Maximum length: 40

Get Invoice Settings — response body — product Settings description Optional, enable Import Product Description

Field	Type	Presence	Description and constraints
`$`	object	Root
`descriptionOptional`	boolean	Optional	Flag indicating if the product description is optional or not
`enableImportProductDescription`	boolean	Optional	Flag indicating if the product description import is enabled or not

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 Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website

Field	Type	Presence	Description and constraints
`$`	object	Root
`address`	Model	Optional	Expand Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website address
`customValues`	array	Optional
`customValues[]`	string	Each item
`logoUrl`	string	Optional
`name`	string	Required within parent
`phoneNo`	string	Optional
`website`	string	Optional

Referenced models: Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website address

Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage

Field	Type	Presence	Description and constraints
`$`	object	Root
`enable`	boolean	Required within parent	Enable late fees
`frequency`	JSON	Required within parent	Late Fees Frequency
`frequency (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time
`grace`	JSON	Optional	Late Fees Grace
`grace (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage grace interval: day
`maxLateFees`	JSON	Optional	Max late fees payable
`maxLateFees (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed
`type`	string	Required within parent	Late Fees Type Known values: fixed, percentage
`value`	JSON	Required within parent
`value (anyOf 1)`	number	Alternative	Late Fees Value
`value (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time, Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage grace interval: day, Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Get Invoice Settings — response body — payment Methods stripe

Field	Type	Presence	Description and constraints
`$`	object	Root
`stripe`	JSON	Required within parent	Payment Method
`stripe (allOf 1)`	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe stripe enable Bank Debit Only

Referenced models: Get Invoice Settings — response body — payment Methods stripe stripe enable Bank Debit Only

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_invoice_settings. Catalog operation: get-invoice-settings. 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

Report an issue with this page