HubSpot: Update — invoices update Invoice

← Invoices operations · Get started

Operation hubspot.invoices_update_invoice

Provider route: PATCH /crm/objects/2026-09/invoices/{invoiceId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["invoices"]["updateInvoice"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(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_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(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	Pattern: .+
query	object	Optional	Additional keys: not allowed
query.idProperty	string	Optional
body	Model	Required within parent	Expand Update — users update User — request body — body

Referenced models: Update — users update User — 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 Merge objects — invoices merge — response body

Referenced models: Merge objects — invoices merge — response body

Schemas

Update — users update User — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object to be updated. Each key is a property name, and each value is the new value for that property. All properties are expected to be strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Merge objects — invoices merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	A string used for tracing the write operations on this object.
properties	object	Required within parent	A map of property names to their current values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, each with a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — invoices get Invoice — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — invoices get Invoice — response body — warnings item

Referenced models: Read — invoices get Invoice — response body — warnings item, Read — invoices get Invoice — response body — properties With History value item

Read — invoices get Invoice — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string representing the category of the warning.
context	object	Required within parent	An object with additional properties providing context for the warning, where each property is a string. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Read — invoices get Invoice — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	The unique identifier for the source of the value, represented as a string.
sourceLabel	string	Optional	A label providing additional context or description of the source, represented as a string.
sourceType	string	Required within parent	The type of source from which the value originated. This is a string.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the value, represented as an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The value associated with the timestamp. It is represented as a string.

Policy, approvals and errors

SDK function policy ID: hubspot.invoices_update_invoice. Catalog operation: invoices_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: ["crm.objects.invoices.write"]

Official provider source