HubSpot: Taxes schemas

← Taxes operations · All schemas

Archive batch objects — taxes batch Delete Taxes — 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 array is used to specify which objects are included in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

Referenced models: Archive a batch of contacts — request body — body inputs item

Batch create objects — taxes batch Create Taxes — 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 objects, each representing a simple public object to be created. Each object must include properties and associations necessary for the creation process.
inputs[]	Model	Each item	Expand Batch create objects — taxes batch Create Taxes — request body — body inputs item

Referenced models: Batch create objects — taxes batch Create Taxes — request body — body inputs item

Batch create objects — taxes batch Create Taxes — 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 object being created and other objects. Each item in the array is a PublicAssociationsForObject, which specifies the target object and the types of associations.
associations[]	Model	Each item	Expand Create — taxes create Tax — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes. This ID can help identify the specific operation in logs or error reports.
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 — taxes create Tax — request body — body associations item

Batch upsert objects — taxes batch Upsert Taxes — 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 items, each representing an object to be created or updated. This property is required.
inputs[]	Model	Each item	Expand Batch upsert objects — taxes batch Upsert Taxes — request body — body inputs item

Referenced models: Batch upsert objects — taxes batch Upsert Taxes — request body — body inputs item

Batch upsert objects — taxes batch Upsert Taxes — 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 required for identifying the object in the batch operation.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used for tracing the write operation, 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 each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Batch upsert objects — taxes.batchUpsertTaxes — 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 has been 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 their values, including a history of previous values, represented as arrays of ValueWithTimestamp objects. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — taxes get Tax — 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.
warnings	array	Optional	An array of warnings related to this object, each represented as a PublicObjectWarning.
warnings[]	Model	Each item	Expand Read — taxes get Tax — response body — warnings item

Referenced models: Read — taxes get Tax — response body — warnings item, Read — taxes get Tax — response body — properties With History value item

Batch upsert objects — taxes.batchUpsertTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Taxes 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 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 SimplePublicUpsertObject items that represent the results of the batch upsert operation.
results[]	Model	Each item	Expand Batch upsert objects — taxes.batchUpsertTaxes — 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: Batch upsert objects — taxes.batchUpsertTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — taxes.batchUpsertTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Taxes 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 items, detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — taxes.batchGetTaxes — 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 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 Batch upsert objects — taxes.batchUpsertTaxes — 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: Batch upsert objects — taxes.batchUpsertTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Read batch objects — taxes.batchGetTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — taxes create Tax — 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 existing objects. Each association specifies the related object and the type of relationship.
associations[]	Model	Each item	Expand Create — taxes create Tax — request body — body associations item
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 attributes of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — taxes create Tax — request body — body associations item

Create — taxes create Tax — 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 Archive a batch of contacts — request body — body inputs item
types	array	Required within parent	An array of association specifications, each defining a type of relationship between the objects. Each specification includes details like the category and type ID of the association.
types[]	Model	Each item	Expand Create — taxes create Tax — request body — body associations item types item

Referenced models: Archive a batch of contacts — request body — body inputs item, Create — taxes create Tax — request body — body associations item types item

Create — taxes create Tax — 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, which can be one of the following: 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or '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

Create — taxes create Tax — 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 CRM object.
objectWriteTraceId	string	Optional	An identifier used for tracing the write operations related to 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 arrays of past values, each with a timestamp indicating when the value was set. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — taxes get Tax — 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 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 — taxes get Tax — response body — warnings item

Referenced models: Read — taxes get Tax — response body — warnings item, Read — taxes get Tax — response body — properties With History value item

List associations — taxes 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 — taxes get Taxes — 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 its labels.
results[]	Model	Each item	Expand List associations — taxes get Associations By To Object Type — response body — results item

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

List associations — taxes 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 with labels, detailing the types of associations and their respective labels.
associationTypes[]	Model	Each item	Expand List associations — taxes 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. This is a string value.

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

List associations — taxes 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. 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 object type ID from which the association originates.
label	string	Optional	A string representing the label associated with the association.
toObjectTypeId	string	Optional	A string representing the object type ID 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 — taxes get Taxes — 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 — taxes get Taxes — 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 — taxes get Tax — response body

Referenced models: List — taxes get Taxes — response body — paging, Read — taxes get Tax — response body

List — taxes get Taxes — 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 — taxes get Taxes — response body — paging next

Referenced models: List — taxes get Taxes — response body — paging next

List — taxes get Taxes — 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 fetch the next set of results in a paginated response.
link	string	Optional	A URL string that points to the next page of results in the paginated response.

Read batch objects — taxes batch Get Taxes — 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 representing an object to be read. Each object must have an 'id' property.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned for each object. If a specified property is not present on an object, it 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. If a specified property is not present on an object, it will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of contacts — request body — body inputs item

Read batch objects — taxes.batchGetTaxes — 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 indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error, with each key mapping 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 specific error conditions.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies the error instance.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or recommended remediation steps for the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message that describes the error.
status	string	Required within parent	A string representing 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 — taxes.batchGetTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Taxes 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, 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — taxes create Tax — 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: Create — taxes create Tax — response body

Read batch objects — taxes.batchGetTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Taxes 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 standard errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — taxes.batchGetTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context 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 that occurred 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Create — taxes create Tax — 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: Create — taxes create Tax — response body, Read batch objects — taxes.batchGetTaxes — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Read — taxes get Tax — 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 has been 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 associated IDs, providing details about related objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — taxes get Tax — 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	A string identifier 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 values, including historical changes, with each value containing a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — taxes get Tax — 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 — taxes get Tax — response body — warnings item

Referenced models: Read — taxes get Tax — response body — associations value, Read — taxes get Tax — response body — warnings item, Read — taxes get Tax — response body — properties With History value item

Read — taxes get Tax — 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 — taxes search Taxes — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object containing details about the association. This property is required.
results[]	Model	Each item	Expand Read — taxes get Tax — response body — associations value results item

Referenced models: Read — taxes get Tax — response body — associations value results item, Search objects — taxes search Taxes — response body — paging

Read — taxes get Tax — 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	A string representing the unique identifier for the associated object.
type	string	Required within parent	A string indicating the type of the associated object.

Read — taxes get Tax — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	An identifier for the source of the value. This is a string.
sourceLabel	string	Optional	A label describing the source of the value. This is 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 this value. This is an integer. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The actual value being recorded. This is a string.

Read — taxes get Tax — 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 providing additional context for the warning, with properties as key-value pairs. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Search objects — taxes search Taxes — 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. It 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 specify the criteria for filtering search results. Each filter group contains a set of filters that are combined using logical AND operations.
filterGroups[]	Model	Each item	Expand Search objects — taxes search Taxes — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. This limits the number of objects included in the search results. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be included in the search results. Only the specified properties will be returned for each object.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects. This query is used to perform a full-text search across specified properties.
sorts	array	Required within parent	An array of strings that define the sorting order of the search results. Each string specifies a property to sort by, optionally followed by 'ASC' or 'DESC' to indicate ascending or descending order.
sorts[]	string	Each item

Referenced models: Search objects — taxes search Taxes — request body — body filter Groups item

Search objects — taxes search Taxes — 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 name, operator, and value(s) to apply the filter logic.
filters[]	Model	Each item	Expand Search objects — taxes search Taxes — request body — body filter Groups item filters item

Referenced models: Search objects — taxes search Taxes — request body — body filter Groups item filters item

Search objects — taxes search Taxes — 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 string value used for range-based operators to specify the upper bound of the filter.
operator	string	Required within parent	The operator used to compare the property value. 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. It is a string that identifies the specific field of the object.
value	string	Optional	The value to compare against the specified property. This is a string and is used in conjunction with the operator to determine matches.
values	array	Optional	An array of string values used for operators that require multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search objects — taxes search Taxes — 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 — taxes search Taxes — response body — paging
results	array	Required within parent	An array of SimplePublicObject items, each representing an individual object within the collection.
results[]	Model	Each item	Expand Create — taxes create Tax — 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 — taxes search Taxes — response body — paging, Create — taxes create Tax — response body

Search objects — taxes search Taxes — 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 — taxes get Taxes — response body — paging next
prev	Model	Optional	Expand Search objects — taxes search Taxes — response body — paging prev

Referenced models: List — taxes get Taxes — response body — paging next, Search objects — taxes search Taxes — response body — paging prev

Search objects — taxes search Taxes — 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 position in the result set before the current page.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — taxes batch Update Taxes — 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 item in the array represents a single CRM object with its properties and optional associations to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update batch objects — taxes batch Update Taxes — request body — body inputs item

Referenced models: Update batch objects — taxes batch Update Taxes — request body — body inputs item

Update batch objects — taxes batch Update Taxes — 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	An optional string identifier used for tracing the write operation.
properties	object	Required within parent	A map of property names to their values for the CRM object. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — taxes update Tax — 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 corresponding property values. Each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys