Product Relationship (ProductSubstitute) table/entity reference (Microsoft Dynamics 365)

Information about the selling relationship between two products, including the relationship type, such as up-sell, cross-sell, substitute, or accessory.

Messages

The following table lists the messages for the Product Relationship (ProductSubstitute) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Associate Event: True	Associate records	Associate records
Create Event: True	POST /productsubstitutes See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /productsubstitutes(productsubstituteid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
Retrieve Event: True	GET /productsubstitutes(productsubstituteid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /productsubstitutes See Query data	Query data
Update Event: True	PATCH /productsubstitutes(productsubstituteid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /productsubstitutes(productsubstituteid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the Product Relationship (ProductSubstitute) table.

Property	Value
DisplayName	Product Relationship
DisplayCollectionName	Product Relationships
SchemaName	ProductSubstitute
CollectionSchemaName	ProductSubstitutes
EntitySetName	productsubstitutes
LogicalName	productsubstitute
LogicalCollectionName	productsubstitutes
PrimaryIdAttribute	productsubstituteid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• Direction
• ImportSequenceNumber
• Name
• OverriddenCreatedOn
• ProductId
• ProductSubstituteId
• SalesRelationshipType
• statuscode
• SubstitutedProductId
• TimeZoneRuleVersionNumber
• TransactionCurrencyId
• UTCConversionTimeZoneCode

Direction

Property	Value
Description	Select whether the relationship is unidirectional or bidirectional.
DisplayName	Direction
IsValidForForm	True
IsValidForRead	True
LogicalName	direction
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	productsellingrelationshipdirection

Direction Choices/Options

Value	Label
0	Uni-Directional
1	Bi-Directional

ImportSequenceNumber

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

Name

Property	Value
Description	name
DisplayName	name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OverriddenCreatedOn

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

ProductId

Property	Value
Description	Shows the product that the relationship is defined for.
DisplayName	Product
IsValidForForm	True
IsValidForRead	True
LogicalName	productid
RequiredLevel	SystemRequired
Type	Lookup
Targets	product

ProductSubstituteId

Property	Value
Description	Shows the unique identifier of the product relationship.
DisplayName	Product Relationship ID
IsValidForForm	True
IsValidForRead	True
LogicalName	productsubstituteid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SalesRelationshipType

Property	Value
Description	Select the type of the product relationship.
DisplayName	Sales Relationship Type
IsValidForForm	True
IsValidForRead	True
LogicalName	salesrelationshiptype
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue	3
GlobalChoiceName	productsellingrelationshiptype

SalesRelationshipType Choices/Options

Value	Label
0	Up-sell
1	Cross-sell
2	Accessory
3	Substitute

statuscode

Property	Value
Description	Shows whether the product relationship is active or inactive.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	productsubstitute_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

SubstitutedProductId

Property	Value
Description	Select the related product that the relationship needs to be defined for.
DisplayName	Related Product
IsValidForForm	True
IsValidForRead	True
LogicalName	substitutedproductid
RequiredLevel	SystemRequired
Type	Lookup
Targets	product

TimeZoneRuleVersionNumber

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

TransactionCurrencyId

Property	Value
Description	Shows the currency associated with the record.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	transactioncurrencyid
RequiredLevel	None
Type	Lookup
Targets	transactioncurrency

UTCConversionTimeZoneCode

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• ExchangeRate
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• statecode
• VersionNumber

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

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
RequiredLevel	None
Type	Decimal
ImeMode	Disabled
MaxValue	100000000000
MinValue	1E-12
Precision	12
SourceTypeMask	0

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

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

ModifiedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

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

statecode

Property	Value
Description	Select the product relationship's status.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue	0
GlobalChoiceName	productsubstitute_statecode

statecode Choices/Options

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• lk_ProductSubstitute_createdby
• lk_ProductSubstitute_createdonbehalfby
• lk_ProductSubstitute_modifiedby
• lk_ProductSubstitute_modifiedonbehalfby
• organization_ProductSubstitute
• product_ProductSubstitute_productid
• product_ProductSubstitute_substitutedproductid
• transactioncurrency_ProductSubstitute

lk_ProductSubstitute_createdby

One-To-Many Relationship: systemuser lk_ProductSubstitute_createdby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_ProductSubstitute_createdonbehalfby

One-To-Many Relationship: systemuser lk_ProductSubstitute_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_ProductSubstitute_modifiedby

One-To-Many Relationship: systemuser lk_ProductSubstitute_modifiedby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_ProductSubstitute_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_ProductSubstitute_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

organization_ProductSubstitute

One-To-Many Relationship: organization organization_ProductSubstitute

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

product_ProductSubstitute_productid

One-To-Many Relationship: product product_ProductSubstitute_productid

Property	Value
ReferencedEntity	product
ReferencedAttribute	productid
ReferencingAttribute	productid
ReferencingEntityNavigationPropertyName	productid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

product_ProductSubstitute_substitutedproductid

One-To-Many Relationship: product product_ProductSubstitute_substitutedproductid

Property	Value
ReferencedEntity	product
ReferencedAttribute	productid
ReferencingAttribute	substitutedproductid
ReferencingEntityNavigationPropertyName	substitutedproductid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

transactioncurrency_ProductSubstitute

One-To-Many Relationship: transactioncurrency transactioncurrency_ProductSubstitute

Property	Value
ReferencedEntity	transactioncurrency
ReferencedAttribute	transactioncurrencyid
ReferencingAttribute	transactioncurrencyid
ReferencingEntityNavigationPropertyName	transactioncurrencyid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• ProductSubstitute_AsyncOperations
• ProductSubstitute_BulkDeleteFailures
• productsubstitute_MailboxTrackingFolders
• ProductSubstitute_PrincipalObjectAttributeAccess
• ProductSubstitute_ProcessSession
• ProductSubstitute_SyncErrors

ProductSubstitute_AsyncOperations

Many-To-One Relationship: asyncoperation ProductSubstitute_AsyncOperations

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	ProductSubstitute_AsyncOperations
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

ProductSubstitute_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure ProductSubstitute_BulkDeleteFailures

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	ProductSubstitute_BulkDeleteFailures
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

productsubstitute_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder productsubstitute_MailboxTrackingFolders

Property	Value
ReferencingEntity	mailboxtrackingfolder
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	productsubstitute_MailboxTrackingFolders
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

ProductSubstitute_PrincipalObjectAttributeAccess

Many-To-One Relationship: principalobjectattributeaccess ProductSubstitute_PrincipalObjectAttributeAccess

Property	Value
ReferencingEntity	principalobjectattributeaccess
ReferencingAttribute	objectid
ReferencedEntityNavigationPropertyName	ProductSubstitute_PrincipalObjectAttributeAccess
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

ProductSubstitute_ProcessSession

Many-To-One Relationship: processsession ProductSubstitute_ProcessSession

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	ProductSubstitute_ProcessSession
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

ProductSubstitute_SyncErrors

Many-To-One Relationship: syncerror ProductSubstitute_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	ProductSubstitute_SyncErrors
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference