HubSpot: Invoices schemas

← Invoices operations · All schemas

Archive batch — invoices batch Delete Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing a unique identifier for a CRM object. This property is required and is used to specify the objects involved in the batch operation.
inputs[]	Model	Each item	Expand Batch archive price book items — request body — body inputs item

Referenced models: Batch archive price book items — request body — body inputs item

Batch create objects — invoices batch Create Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations for a single CRM object to be created.
inputs[]	Model	Each item	Expand Batch create objects — invoices batch Create Invoices — request body — body inputs item

Referenced models: Batch create objects — invoices batch Create Invoices — request body — body inputs item

Batch create objects — invoices batch Create Invoices — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations that define relationships between the CRM object being created and other objects. Each association is represented by the PublicAssociationsForObject schema.
associations[]	Model	Each item	Expand Create — invoices create Invoice — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object. This is optional and can be used for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — invoices create Invoice — request body — body associations item

Create — invoices create Invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link the new CRM object to other objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — invoices create Invoice — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object to be created. Each key is a property name and each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — invoices create Invoice — request body — body associations item

Create — invoices create Invoice — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Create — invoices create Invoice — request body — body associations item to
types	array	Required within parent	An array of association specifications that define the types of relationships between the objects. Each item in the array specifies a category and type ID for the association.
types[]	Model	Each item	Expand Create — invoices create Invoice — request body — body associations item types item

Referenced models: Create — invoices create Invoice — request body — body associations item types item, Create — invoices create Invoice — request body — body associations item to

Create — invoices create Invoice — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for the public object. This is a string value that is required for identifying the object in API requests.

Create — invoices create Invoice — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	The category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the unique identifier for the type of association. Format: int32

List associations — invoices get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
paging	Model	Optional	Expand List — invoices get Invoices — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object contains details about the association types and the associated object ID.
results[]	Model	Each item	Expand List associations — invoices get Associations By To Object Type — response body — results item

Referenced models: List — invoices get Invoices — response body — paging, List associations — invoices get Associations By To Object Type — response body — results item

List associations — invoices get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications, each including a label. These define the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — invoices get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which associations are made. It is a string.

Referenced models: List associations — invoices get Associations By To Object Type — response body — results item association Types item

List associations — invoices get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	The category of the association, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the type ID of the object from which the association originates.
label	string	Optional	A string label that describes the association.
toObjectTypeId	string	Optional	A string representing the type ID of the object to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — invoices get Invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand List — invoices get Invoices — response body — paging
results	array	Required within parent	An array of simple public objects with their associations. Each object includes properties and associated object details.
results[]	Model	Each item	Expand Read — invoices get Invoice — response body

Referenced models: List — invoices get Invoices — response body — paging, Read — invoices get Invoice — response body

List — invoices get Invoices — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — invoices get Invoices — response body — paging next

Referenced models: List — invoices get Invoices — response body — paging next

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.

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 batch objects — invoices batch Get Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects representing the IDs of the objects to be read.
inputs[]	Model	Each item	Expand Batch archive price book items — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. Using this parameter may reduce the maximum number of objects that can be read in a single request.
propertiesWithHistory[]	string	Each item

Referenced models: Batch archive price book items — request body — body inputs item

Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string specifying the category of the error.
context	object	Required within parent	An object containing additional context about the error, where each key is a context name and each value is an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing additional categorization for the error.

Referenced models: Batch insert events — response body — errors item errors item

Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Invoices Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each item being a simple public object.
results[]	Model	Each item	Expand Merge objects — invoices merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Merge objects — invoices merge — response body

Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Invoices Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — invoices merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — invoices merge — response body

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 — 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.

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 — 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.

Search objects — invoices search Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token. This is used to fetch the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to apply multiple filters to the search query. Each filter group can contain multiple filters that define specific conditions.
filterGroups[]	Model	Each item	Expand Search objects — invoices search Invoices — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return per page. Format: int32
properties	array	Required within parent	An array of strings indicating which properties of the CRM objects should be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects. This can be used to perform a text search across various fields.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results. Each string represents a property name followed by the sort direction (e.g., 'propertyName ASC' or 'propertyName DESC').
sorts[]	string	Each item

Referenced models: Search objects — invoices search Invoices — request body — body filter Groups item

Search objects — invoices search Invoices — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filter objects that specify the conditions to be applied in the search query. Each filter defines a property, an operator, and a value to filter by.
filters[]	Model	Each item	Expand Search objects — invoices search Invoices — request body — body filter Groups item filters item

Referenced models: Search objects — invoices search Invoices — request body — body filter Groups item filters item

Search objects — invoices search Invoices — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional upper boundary value for range-based filters. It is a string.
operator	string	Required within parent	The operator used to compare the property value against the filter value(s). Valid operators include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to which the filter is applied. It is a string.
value	string	Optional	The specific value to be used in the filter comparison. It is a string.
values	array	Optional	An array of values used for filters that require multiple entries, such as 'IN' or 'NOT_IN'. Each item in the array is a string.
values[]	string	Each item

Search objects — invoices search Invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search objects — invoices search Invoices — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Merge objects — invoices merge — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — invoices search Invoices — response body — paging, Merge objects — invoices merge — response body

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

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.

Update batch objects — invoices batch Update Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for the CRM objects to be updated.
inputs[]	Model	Each item	Expand Update batch objects — invoices batch Update Invoices — request body — body inputs item

Referenced models: Update batch objects — invoices batch Update Invoices — request body — body inputs item

Update batch objects — invoices batch Update Invoices — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	The id to be updated. This can be the object id, or the unique property value of the idProperty property
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operations on the object.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM objects. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — invoices batch Upsert Invoices — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each containing the properties required to create or update a simple public object.
inputs[]	Model	Each item	Expand Upsert batch objects — invoices batch Upsert Invoices — request body — body inputs item

Referenced models: Upsert batch objects — invoices batch Upsert Invoices — request body — body inputs item

Upsert batch objects — invoices batch Upsert Invoices — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier for the object. This is used to identify the object in operations.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. These properties define the data for the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the object.
new	boolean	Required within parent	A boolean indicating whether the object is newly created.
objectWriteTraceId	string	Optional	An identifier used for tracing the write operation that created or updated the 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 entry containing a list of values with timestamps. 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 the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL for accessing the object.
warnings	array	Optional	A list of warnings associated with the 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

Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Invoices Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items, representing the individual results of the upsert operation for each object.
results[]	Model	Each item	Expand Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Invoices Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects, detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items, representing the objects that were successfully upserted in the batch operation.
results[]	Model	Each item	Expand Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — invoices.batchGetInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — invoices.batchUpsertInvoices — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item