HubSpot: Read — invoices get Invoice

← Invoices operations · Get started

Operation hubspot.invoices_get_invoice

Provider route: GET /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"]["getInvoice"]>[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.getInvoice(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.get_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.archived	boolean	Optional	Default: false
query.associations	array	Optional
query.associations[]	string	Each item
query.idProperty	string	Optional
query.properties	array	Optional
query.properties[]	string	Each item
query.propertiesWithHistory	array	Optional
query.propertiesWithHistory[]	string	Each item

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 Read — invoices get Invoice — response body

Referenced models: Read — invoices get Invoice — response body

Schemas

Read — invoices get Invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
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
associations	object	Optional	A map of associated object types to their respective associated IDs, representing the relationships this object has with other objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — invoices get Invoice — response body — associations value
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 CRM object.
objectWriteTraceId	string	Optional	An identifier used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values with historical timestamps, showing how the values have changed over time. 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	The URL link to access this object.
warnings	array	Optional	An array of warnings related to this object, providing additional context or information.
warnings[]	Model	Each item	Expand Read — invoices get Invoice — response body — warnings item

Referenced models: Read — invoices get Invoice — response body — associations value, 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 — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search objects — invoices search Invoices — response body — paging
results	array	Required within parent	An array of associated IDs, where each item is an object containing the ID and type of the association.
results[]	Model	Each item	Expand Read — invoices get Invoice — response body — associations value results item

Referenced models: Read — invoices get Invoice — response body — associations value results item, Search objects — invoices search Invoices — response body — paging

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.

Read — invoices get Invoice — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the associated object. It is a string that represents the ID of the object involved in the association.
type	string	Required within parent	The type of association between the objects. This is a string that categorizes the nature of the relationship.

Search objects — invoices search Invoices — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List — invoices get Invoices — response body — paging next
prev	Model	Optional	Expand Search objects — invoices search Invoices — response body — paging prev

Referenced models: List — invoices get Invoices — response body — paging next, Search objects — invoices search Invoices — response body — paging prev

List — invoices get Invoices — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to indicate the starting point for the next page of results.
link	string	Optional	A URL string that provides the direct link to access the next page of results.

Search objects — invoices search Invoices — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string that serves as a cursor for fetching the previous page of results.
link	string	Optional	A string containing the URL link to the previous page of results.

Policy, approvals and errors

SDK function policy ID: hubspot.invoices_get_invoice. Catalog operation: invoices_get_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.read"]

Official provider source