Skip to navigation
API ReferenceTypesObjects

Deal

OBJECT
A commercialization deal tracked through a pipeline of stages.

Fields

createdAtStringRequired
The deal's creation date.
dealContactslist of DealContactsRequired
The contacts involved in the deal.
dealMatterslist of DealMattersRequired
The links between the deal and the disclosures, patents, and other matters attached to it.
idStringRequired
The deal's unique identifier.
updatedAtStringRequired
The date the deal was last updated.
agreementsCountIntegerOptional
The number of agreements linked to the deal.
archivedAtStringOptional
The date the deal was archived. Returns null if the deal is active.
archivedByUserUserOptional
The user who archived the deal.
commentsCountIntegerOptional
The number of comments on the deal.
createdByUserUserOptional
The user who created the deal.
createdByUserIdStringOptional
The unique identifier of the user who created the deal.
descriptionStringOptional
The deal's description.
disclosuresCountIntegerOptional
The number of disclosures linked to the deal.
externalIdStringOptional
The deal's identifier in an external system. Set when the deal is imported.
lastActivityAtStringOptional
The date of the most recent activity on the deal.
matterDocumentsCountIntegerOptional
The number of documents attached to the deal.
opportunitiesCountIntegerOptional
The number of opportunities linked to the deal.
ownerUserUserOptional
The user who owns the deal.
sourceEnumDealSourceEnumOptional
How the deal was created, such as manually or by import.
Allowed values:
stageLookupLookupUnionOptional

The deal’s pipeline stage. A global or account-specific lookup value.

titleStringOptional
The deal's title.
typeEnumDealTypeEnumOptional
The deal's type.
Allowed values:
updatedByUserUserOptional
The user who last updated the deal.
updatedByUserIdStringOptional
The unique identifier of the user who last updated the deal.

Referenced by

Queries