HubSpot: Deal splits schemas

← Deal splits operations · All schemas

Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of deal split inputs
inputs[]	Model	Each item	Expand Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item

Referenced models: Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item

Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	integer	Required within parent	The unique identifier for the deal. Format: int64
splits	array	Required within parent	An array of deal split inputs, each containing an owner ID and a percentage of the deal split.
splits[]	Model	Each item	Expand Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item splits item

Referenced models: Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item splits item

Create or replace deal splits for deals with the provided I Ds Deal split percentages for each deal must sum up to 1 0 (100%) and may have up to 8 decimal places — request body — body inputs item splits item

Field	Type	Presence	Description and constraints
$	object	Root
ownerId	integer	Required within parent	The unique identifier of the owner receiving the deal split. Format: int32
percentage	number	Required within parent	The portion of the deal assigned to the owner, expressed as a percentage. The total percentage for all splits in a deal must sum up to 1.0 (100%) and can have up to 8 decimal places.

Read a batch of deal split objects by their associated deal object internal ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of deal split inputs
inputs[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — request body — body inputs item

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — request body — body inputs item

Read a batch of deal split objects by their associated deal object internal ID — 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 public object.

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	The error category
context	object	Required within parent	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects that provide further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	The id of the error
links	object	Required within parent	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	The error message
status	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	object	Optional	A specific category that contains more specific detail about the error

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

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the deal associated with the deal splits.
splits	array	Required within parent	An array of deal split objects, each representing a portion of the deal assigned to an owner.
splits[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item

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, represented as a string.
objectWriteTraceId	string	Optional	A string identifier used for tracing 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 containing a value and its associated timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item 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 associated with this object.

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item properties With History value item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item splits item 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 providing a human-readable label for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
timestamp	string	Required within parent	A string in date-time format indicating when the value was recorded. 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	A string representing the main value being tracked.

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch operation was completed, in date-time format. Format: date-time
links	object	Optional	A map of link names to associated URIs for additional resources or documentation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp indicating when the batch operation was requested, in date-time format. Format: date-time
results	array	Required within parent	An array of deal-to-deal split objects representing the results of the batch operation.
results[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The timestamp indicating when the batch operation started, in date-time format. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Deal To Deal Splits With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch operation was completed, in date-time format. Format: date-time
errors	array	Optional	An array of error objects detailing the errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs for additional resources or documentation. 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 timestamp indicating when the batch operation was requested, in date-time format. Format: date-time
results	array	Required within parent	An array of deal-to-deal split objects representing the results of the batch operation.
results[]	Model	Each item	Expand Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The timestamp indicating when the batch operation started, in date-time format. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Read a batch of deal split objects by their associated deal object internal ID — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item