HighLevel: Update invoice late fees configuration

← Invoices operations · Get started

Operation gohighlevel.update_invoice_late_fees_configuration

Provider route: PATCH /invoices/{invoiceId}/late-fees-configuration. 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"]["updateInvoiceLateFeesConfiguration"]>[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.updateInvoiceLateFeesConfiguration(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_late_fees_configuration(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 late fees configuration — request body — body

Referenced models: Update invoice late fees configuration — 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

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 late fees configuration — 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
lateFeesConfiguration	JSON	Required within parent	late fees configuration
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage

Referenced models: Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage

Create & Send — request body — 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 Create & Send — request body — 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 Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day
maxLateFees	JSON	Optional	Max late fees payable
maxLateFees (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed
type	string	Required within parent	Late Fees Type One of: fixed, percentage
value	number	Required within parent	Late Fees Value

Referenced models: Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees interval One of: minute, hour, day, week, month, one_time
intervalCount	number	Required within parent	Late fees interval count

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees grace interval One of: day
intervalCount	number	Required within parent	Late fees grace interval count

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	One of: fixed
value	number	Required within parent	Max late fees to pay

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_invoice_late_fees_configuration. Catalog operation: update-invoice-late-fees-configuration. 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.

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

Official provider source