OpportunitySalesProcess Entity Reference

Base entity for process Opportunity Sales Process

Added by: Sales Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/opportunitysalesprocesses
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/opportunitysalesprocesses(businessprocessflowinstanceid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/opportunitysalesprocesses(businessprocessflowinstanceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/opportunitysalesprocesses
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/opportunitysalesprocesses(businessprocessflowinstanceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/opportunitysalesprocesses(businessprocessflowinstanceid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName OpportunitySalesProcesses
DisplayCollectionName Opportunity Sales Process
DisplayName Opportunity Sales Process
EntitySetName opportunitysalesprocesses
IsBPFEntity True
LogicalCollectionName opportunitysalesprocesses
LogicalName opportunitysalesprocess
OwnershipType OrganizationOwned
PrimaryIdAttribute businessprocessflowinstanceid
PrimaryNameAttribute name
SchemaName OpportunitySalesProcess

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ActiveStageId

Property Value
Description Unique identifier of the active stage for the Business Process Flow instance.
DisplayName Active Stage
IsValidForForm True
IsValidForRead True
LogicalName activestageid
RequiredLevel None
Targets processstage
Type Lookup

ActiveStageStartedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when current active stage is started.
DisplayName Active Stage Started On
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName activestagestartedon
RequiredLevel None
Type DateTime

bpf_quoteid

Added by: Project Service Automation Solution

Property Value
Description
DisplayName quote
IsValidForForm True
IsValidForRead True
LogicalName bpf_quoteid
RequiredLevel None
Targets quote
Type Lookup

bpf_salesorderid

Added by: Project Service Automation Solution

Property Value
Description
DisplayName salesorder
IsValidForForm True
IsValidForRead True
LogicalName bpf_salesorderid
RequiredLevel None
Targets salesorder
Type Lookup

BusinessProcessFlowInstanceId

Property Value
Description Unique identifier for Opportunity Sales Process bpf entity instances
DisplayName Opportunity Sales Process Instance Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName businessprocessflowinstanceid
RequiredLevel SystemRequired
Type Uniqueidentifier

CompletedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when Business Process Flow instance is completed.
DisplayName Completed On
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName completedon
RequiredLevel None
Type DateTime

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Name

Property Value
Description Process Name.
DisplayName Process Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 200
RequiredLevel ApplicationRequired
Type String

OpportunityId

Property Value
Description Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName Opportunity
IsValidForForm True
IsValidForRead True
LogicalName opportunityid
RequiredLevel None
Targets opportunity
Type Lookup

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

ProcessId

Property Value
Description Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName Process
IsValidForForm True
IsValidForRead True
LogicalName processid
RequiredLevel None
Targets workflow
Type Lookup

QuoteId

Property Value
Description Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName Related Quote
IsValidForForm True
IsValidForRead True
LogicalName quoteid
RequiredLevel None
Targets quote
Type Lookup

SalesOrderId

Property Value
Description Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName Related Sales Order
IsValidForForm True
IsValidForRead True
LogicalName salesorderid
RequiredLevel None
Targets salesorder
Type Lookup

StateCode

Property Value
Description Shows whether the Delve action record is pending, completed, or tracking.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Select the delve action record status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Finished 1
3 Aborted 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

TraversedPath

Property Value
Description Comma delimited string of process stage ids that represent visited stages of the Business Process Flow instance.
DisplayName Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName traversedpath
MaxLength 1250
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

ActiveStageIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName activestageidname
MaxLength 100
RequiredLevel SystemRequired
Type String

bpf_quoteidName

Added by: Project Service Automation Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName bpf_quoteidname
MaxLength 300
RequiredLevel None
Type String

bpf_salesorderidName

Added by: Project Service Automation Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName bpf_salesorderidname
MaxLength 300
RequiredLevel None
Type String

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

Duration

Property Value
Description Duration the business process flow was active.
DisplayName Duration
Format Duration
IsValidForForm True
IsValidForRead True
LogicalName duration
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OpportunityIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName opportunityidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

ProcessIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName processidname
MaxLength 100
RequiredLevel SystemRequired
Type String

QuoteIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName quoteidname
MaxLength 100
RequiredLevel SystemRequired
Type String

SalesOrderIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName salesorderidname
MaxLength 100
RequiredLevel SystemRequired
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

OpportunitySalesProcess_SyncErrors

Added by: System Solution Solution

Same as syncerror entity OpportunitySalesProcess_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName OpportunitySalesProcess_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

opportunitysalesprocess_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity opportunitysalesprocess_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName opportunitysalesprocess_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_opportunitysalesprocess_workflowlogs

Added by: System Solution Solution

Same as workflowlog entity lk_opportunitysalesprocess_workflowlogs Many-To-One relationship.

Property Value
ReferencingEntity workflowlog
ReferencingAttribute asyncoperationid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName workflowlogs_opportunitysalesprocess
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

opportunitysalesprocess_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity opportunitysalesprocess_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName opportunitysalesprocess_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

opportunitysalesprocess_ProcessSession

Added by: System Solution Solution

Same as processsession entity opportunitysalesprocess_ProcessSession Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName opportunitysalesprocess_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

opportunitysalesprocess_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity opportunitysalesprocess_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName opportunitysalesprocess_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

opportunitysalesprocess_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess entity opportunitysalesprocess_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName opportunitysalesprocess_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_opportunitysalesprocess_createdby

Added by: System Solution Solution

See systemuser Entity lk_opportunitysalesprocess_createdby One-To-Many relationship.

lk_opportunitysalesprocess_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_opportunitysalesprocess_createdonbehalfby One-To-Many relationship.

lk_opportunitysalesprocess_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_opportunitysalesprocess_modifiedby One-To-Many relationship.

lk_opportunitysalesprocess_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_opportunitysalesprocess_modifiedonbehalfby One-To-Many relationship.

organization_opportunitysalesprocess

Added by: System Solution Solution

See organization Entity organization_opportunitysalesprocess One-To-Many relationship.

lk_opportunitysalesprocess_activestageid

Added by: System Solution Solution

See processstage Entity lk_opportunitysalesprocess_activestageid One-To-Many relationship.

lk_opportunitysalesprocess_processid

Added by: System Solution Solution

See workflow Entity lk_opportunitysalesprocess_processid One-To-Many relationship.

lk_opportunitysalesprocess_opportunityid

See opportunity Entity lk_opportunitysalesprocess_opportunityid One-To-Many relationship.

lk_opportunitysalesprocess_quoteid

See quote Entity lk_opportunitysalesprocess_quoteid One-To-Many relationship.

lk_opportunitysalesprocess_salesorderid

See salesorder Entity lk_opportunitysalesprocess_salesorderid One-To-Many relationship.

transactioncurrency_opportunitysalesprocess

Added by: System Solution Solution

See transactioncurrency Entity transactioncurrency_opportunitysalesprocess One-To-Many relationship.

bpf_quote_OpportunitySalesProcess

See quote Entity bpf_quote_OpportunitySalesProcess One-To-Many relationship.

bpf_salesorder_OpportunitySalesProcess

See salesorder Entity bpf_salesorder_OpportunitySalesProcess One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
opportunitysalesprocess EntityType