HubSpot: Line items schemas

← Line items operations · All schemas

Batch archive objects — line Items batch Delete Line Items — 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 public object to be included in the batch operation.
inputs[]	Model	Each item	Expand Read batch objects — line Items batch Get Line Items — request body — body inputs item

Referenced models: Read batch objects — line Items batch Get Line Items — request body — body inputs item

Batch create objects — line Items batch Create Line Items — 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 required to create a new CRM object.
inputs[]	Model	Each item	Expand Batch create objects — line Items batch Create Line Items — request body — body inputs item

Referenced models: Batch create objects — line Items batch Create Line Items — request body — body inputs item

Batch create objects — line Items batch Create Line Items — 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 for the CRM object, where each association specifies the related object and the type of association.
associations[]	Model	Each item	Expand Create — line Items create Line Item — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — line Items create Line Item — request body — body associations item

Create — line Items create Line Item — 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 define relationships between the object being created and other objects. Each association is represented by a PublicAssociationsForObject object.
associations[]	Model	Each item	Expand Create — line Items create Line Item — request body — body associations item
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 represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — line Items create Line Item — request body — body associations item

Create — line Items create Line Item — 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 — leads create Lead — 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 is a reference to the 'AssociationSpec' schema, which includes details such as the association category and type ID.
types[]	Model	Each item	Expand Create — line Items create Line Item — request body — body associations item types item

Referenced models: Create — leads create Lead — request body — body associations item to, Create — line Items create Line Item — request body — body associations item types item

Create — line Items create Line Item — 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	A string that indicates 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 that represents the unique identifier for the type of association. Format: int32

GDPR Delete — line Items gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectId	string	Required within parent	The unique identifier of the object to be deleted. This is a required field and is used to specify which contact should be permanently removed.

List associations — line Items 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 — line Items get Line Items — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object includes details about the associated object and the types of associations.
results[]	Model	Each item	Expand List associations — line Items get Associations By To Object Type — response body — results item

Referenced models: List — line Items get Line Items — response body — paging, List associations — line Items get Associations By To Object Type — response body — results item

List associations — line Items 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 with a label, defining the types of associations between objects.
associationTypes[]	Model	Each item	Expand List associations — line Items get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object to which associations are being made. It is a string.

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

List associations — line Items 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. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The type ID of the object from which the association originates.
label	string	Optional	A string label that provides a human-readable name for the association.
toObjectTypeId	string	Optional	The type ID of the object to which the association is directed.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — line Items get Line Items — 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 — line Items get Line Items — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object along with its associated data.
results[]	Model	Each item	Expand Read — line Items get Line Item — response body

Referenced models: List — line Items get Line Items — response body — paging, Read — line Items get Line Item — response body

List — line Items get Line Items — 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 — line Items get Line Items — response body — paging next

Referenced models: List — line Items get Line Items — response body — paging next

List — line Items get Line Items — 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 that acts as a cursor to indicate the position after the last successfully read resource, allowing the retrieval of the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results, enabling easy navigation.

Merge objects — line Items merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the 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, represented as a string.
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 values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each represented by a 'ValueWithTimestamp' object. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — line Items get Line Item — 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 associated with this object, represented as a string.
warnings	array	Optional	An array of warnings related to this object, each represented by a 'PublicObjectWarning' object.
warnings[]	Model	Each item	Expand Read — line Items get Line Item — response body — warnings item

Referenced models: Read — line Items get Line Item — response body — warnings item, Read — line Items get Line Item — response body — properties With History value item

Read batch objects — line Items batch Get Line Items — 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, each containing an ID of a CRM object to be read.
inputs[]	Model	Each item	Expand Read batch objects — line Items batch Get Line Items — request body — body inputs item
properties	array	Required within parent	An array of strings representing the names of the properties to be returned in the response.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings representing the names of the properties for which the history of previous values should be returned.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — line Items batch Get Line Items — request body — body inputs item

Read batch objects — line Items batch Get Line Items — request body — body inputs item

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 CRM object. It is a string that serves as a reference to the specific object in the system.

Read batch objects — lineItems.batchGetLineItems — 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 that categorizes the error.
context	object	Required within parent	An object containing additional context about the error, where each key maps to 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 of the error.
links	object	Required within parent	An object mapping link names to associated URIs that provide 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 that may contain more specific details about the error category.

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

Read batch objects — lineItems.batchGetLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Line Items 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 that provide additional information about 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — line Items merge — response body
startedAt	string	Required within parent	The date and time when the batch operation was 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 — line Items merge — response body

Read batch objects — lineItems.batchGetLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Line Items 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 — lineItems.batchGetLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information about 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 that represent the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — line Items 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 — lineItems.batchGetLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — line Items merge — response body

Read — line Items get Line Item — 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	Indicates whether the object is archived. A boolean value.
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 associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — line Items get Line Item — 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 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 the object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values along with historical timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — line Items get Line Item — 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	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — line Items get Line Item — response body — warnings item

Referenced models: Read — line Items get Line Item — response body — associations value, Read — line Items get Line Item — response body — warnings item, Read — line Items get Line Item — response body — properties With History value item

Read — line Items get Line Item — 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 — line Items search Line Items — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an 'AssociatedId' object.
results[]	Model	Each item	Expand Read — calls get Call — response body — associations value results item

Referenced models: Read — calls get Call — response body — associations value results item, Search — line Items search Line Items — response body — paging

Read — line Items get Line Item — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string representing the unique identifier of the source.
sourceLabel	string	Optional	A string label that provides a human-readable name for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was derived.
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	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The actual value of the property at the given timestamp. It is a string.

Read — line Items get Line Item — 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 indicating the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message that describes the issue or consideration.

Search — line Items search Line Items — 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 for fetching the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups used to specify the search criteria. Each filter group contains a set of filters that define the conditions objects must meet to be included in the search results.
filterGroups[]	Model	Each item	Expand Search — line Items search Line Items — 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 objects should be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to filter the objects based on specific criteria.
sorts	array	Required within parent	An array of strings specifying the properties by which the search results should be sorted.
sorts[]	string	Each item

Referenced models: Search — line Items search Line Items — request body — body filter Groups item

Search — line Items search Line Items — 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 define the criteria for the search. Each filter specifies a property, an operator, and a value or range of values to match against.
filters[]	Model	Each item	Expand Search — line Items search Line Items — request body — body filter Groups item filters item

Referenced models: Search — line Items search Line Items — request body — body filter Groups item filters item

Search — line Items search Line Items — 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	The upper bound value for range-based filters. This is a string.
operator	string	Required within parent	The operator used to compare the property with the 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 filter on. This is a string.
value	string	Optional	The specific value to compare against the property. This is a string.
values	array	Optional	An array of values to use in filters that support multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — line Items search Line Items — 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 — line Items search Line Items — response body — paging
results	array	Required within parent	An array of SimplePublicObject items that are included in the current response.
results[]	Model	Each item	Expand Merge objects — line Items 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 — line Items search Line Items — response body — paging, Merge objects — line Items merge — response body

Search — line Items search Line Items — 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 — line Items get Line Items — response body — paging next
prev	Model	Optional	Expand Search — line Items search Line Items — response body — paging prev

Referenced models: List — line Items get Line Items — response body — paging next, Search — line Items search Line Items — response body — paging prev

Search — line Items search Line Items — 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 token that indicates the cursor position before the current page in the paginated results.
link	string	Optional	A string URL that provides a direct link to access the previous page of results.

Update batch objects — line Items batch Update Line Items — 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 data for a single object to be updated. This includes properties and optional identifiers for each object.
inputs[]	Model	Each item	Expand Update batch objects — line Items batch Update Line Items — request body — body inputs item

Referenced models: Update batch objects — line Items batch Update Line Items — request body — body inputs item

Update batch objects — line Items batch Update Line Items — 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 for the object, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — line Items update Line Item — 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 where keys are property names and values are the new property values. Each property value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — line Items batch Upsert Line Items — 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 and identifiers needed for upserting CRM objects.
inputs[]	Model	Each item	Expand Upsert batch objects — line Items batch Upsert Line Items — request body — body inputs item

Referenced models: Upsert batch objects — line Items batch Upsert Line Items — request body — body inputs item

Upsert batch objects — line Items batch Upsert Line Items — 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 ID is used to determine if the object should be created or updated.
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 for the object, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — lineItems.batchUpsertLineItems — 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 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — line Items get Line Item — 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 for accessing 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 — line Items get Line Item — response body — warnings item

Referenced models: Read — line Items get Line Item — response body — warnings item, Read — line Items get Line Item — response body — properties With History value item

Upsert batch objects — lineItems.batchUpsertLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Line Items 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 results of the upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — lineItems.batchUpsertLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation was 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 — lineItems.batchUpsertLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — lineItems.batchUpsertLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Line Items 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 — lineItems.batchGetLineItems — 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 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 — lineItems.batchUpsertLineItems — 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 — lineItems.batchGetLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — lineItems.batchUpsertLineItems — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item