SalesLiterature Entity Reference

Storage of sales literature, which may contain one or more documents.

Added by: Sales Solution

Messages

Message Web API Operation SDK Assembly
Associate Associate and disassociate entities AssociateRequest or
Associate
Create POST [org URI]/api/data/v9.0/salesliteratures
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/salesliteratures(salesliteratureid)
See Delete
DeleteRequest or
Delete
Disassociate Associate and disassociate entities DisassociateRequest or
Disassociate
Retrieve GET [org URI]/api/data/v9.0/salesliteratures(salesliteratureid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/salesliteratures
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/salesliteratures(salesliteratureid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName SalesLiteratures
DisplayCollectionName Sales Literature
DisplayName Sales Literature
EntitySetName salesliteratures
IsBPFEntity False
LogicalCollectionName salesliteratures
LogicalName salesliterature
OwnershipType OrganizationOwned
PrimaryIdAttribute salesliteratureid
PrimaryNameAttribute name
SchemaName SalesLiterature

Writable attributes

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

Description

Property Value
Description Type additional information to describe the sales literature, such as the intended audience or primary messages.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EmployeeContactId

Property Value
Description Choose the user who is responsible for maintaining or updating the sales literature.
DisplayName Employee Contact
IsValidForForm True
IsValidForRead True
LogicalName employeecontactid
RequiredLevel None
Targets systemuser
Type Lookup

EntityImage

Added by: Active Solution Solution

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage False
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

ExpirationDate

Property Value
DateTimeBehavior UserLocal
Description Enter the expiration date or last day the sales literature can be distributed.
DisplayName Expiration Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName expirationdate
RequiredLevel None
Type DateTime

HasAttachments

Property Value
Description Tells whether the sales literature has one or more attachments.
DisplayName Has Attachments
IsValidForForm False
IsValidForRead True
LogicalName hasattachments
RequiredLevel None
Type Boolean

HasAttachments Options

Value Label
1 Yes
0 No

DefaultValue: False

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

IsCustomerViewable

Property Value
Description Select whether the sales literature can be distributed to prospects and customers or is for internal use only.
DisplayName Customer Viewable
IsValidForForm True
IsValidForRead True
LogicalName iscustomerviewable
RequiredLevel None
Type Boolean

IsCustomerViewable Options

Value Label
1 Yes
0 No

DefaultValue: False

KeyWords

Property Value
Description Type one or more topics or keywords that can be used to search for the sales literature.
DisplayName Key Words
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName keywords
MaxLength 100000
RequiredLevel None
Type Memo

LiteratureTypeCode

Property Value
Description Select a category or type to help others identify the intended use of the sales literature.
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName literaturetypecode
RequiredLevel None
Type Picklist

LiteratureTypeCode Options

Value Label
0 Presentation
1 Product Sheet
2 Policies And Procedures
3 Sales Literature
4 Spreadsheets
5 News
6 Bulletins
7 Price Sheets
8 Manuals
9 Company Background
100001 Marketing Collateral

Name

Property Value
Description Type a descriptive title for the sales literature.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

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 Contains the id of the process associated with the entity.
DisplayName Process Id
IsValidForForm False
IsValidForRead True
LogicalName processid
RequiredLevel None
Type Uniqueidentifier

SalesLiteratureId

Property Value
Description Unique identifier of the sales literature.
DisplayName Sales Literature
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName salesliteratureid
RequiredLevel SystemRequired
Type Uniqueidentifier

StageId

Property Value
Description Contains the id of the stage where the entity is located.
DisplayName (Deprecated) Stage Id
IsValidForForm False
IsValidForRead True
LogicalName stageid
RequiredLevel None
Type Uniqueidentifier

SubjectId

Property Value
Description Choose the subject for the sales literature to relate the item to a product or business group. Administrators can configure subjects under Business Management in the Settings area.
DisplayName Subject
IsValidForForm True
IsValidForRead True
LogicalName subjectid
RequiredLevel ApplicationRequired
Targets subject
Type Lookup

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 A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.
DisplayName (Deprecated) Traversed Path
FormatName Text
IsLocalizable False
IsValidForForm False
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.

CreatedBy

Property Value
Description Shows 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 None
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 Shows who created the record on behalf of another user.
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 None
Type String

EmployeeContactIdName

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

EmployeeContactIdYomiName

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

EntityImage_Timestamp

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

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

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 Shows who last updated 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 None
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 Shows who last updated the record on behalf of another user.
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 None
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

SubjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName subjectidname
MaxLength 100
RequiredLevel None
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.

SalesLiterature_SyncErrors

Added by: System Solution Solution

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

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

SalesLiterature_SharepointDocumentLocation

Added by: System Solution Solution

Same as sharepointdocumentlocation entity SalesLiterature_SharepointDocumentLocation Many-To-One relationship.

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

SalesLiterature_AsyncOperations

Added by: System Solution Solution

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

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

salesliterature_MailboxTrackingFolders

Added by: System Solution Solution

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

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

SalesLiterature_ProcessSessions

Added by: System Solution Solution

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

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

SalesLiterature_BulkDeleteFailures

Added by: System Solution Solution

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

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

salesliterature_principalobjectattributeaccess

Added by: System Solution Solution

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

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

sales_literature_items

Same as salesliteratureitem entity sales_literature_items Many-To-One relationship.

Property Value
ReferencingEntity salesliteratureitem
ReferencingAttribute salesliteratureid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName sales_literature_items
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_salesliteraturebase_createdby

Added by: System Solution Solution

See systemuser Entity lk_salesliteraturebase_createdby One-To-Many relationship.

lk_salesliterature_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_salesliterature_createdonbehalfby One-To-Many relationship.

lk_salesliteraturebase_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_salesliteraturebase_modifiedby One-To-Many relationship.

lk_salesliterature_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_salesliterature_modifiedonbehalfby One-To-Many relationship.

organization_sales_literature

Added by: System Solution Solution

See organization Entity organization_sales_literature One-To-Many relationship.

processstage_salesliteratures

Added by: System Solution Solution

See processstage Entity processstage_salesliteratures One-To-Many relationship.

system_user_sales_literature

Added by: System Solution Solution

See systemuser Entity system_user_sales_literature One-To-Many relationship.

TransactionCurrency_SalesLiterature

Added by: System Solution Solution

See transactioncurrency Entity TransactionCurrency_SalesLiterature One-To-Many relationship.

subject_sales_literature

Added by: System Solution Solution

See subject Entity subject_sales_literature One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the SalesLiterature entity is the first entity in the relationship. Listed by SchemaName.

productsalesliterature_association

See product Entity productsalesliterature_association Many-To-Many Relationship.

competitorsalesliterature_association

IntersectEntityName: competitorsalesliterature

Entity 1

Property Value
IntersectAttribute salesliteratureid
IsCustomizable False
LogicalName salesliterature
NavigationPropertyName competitorsalesliterature_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName competitor
IntersectAttribute competitorid
NavigationPropertyName competitorsalesliterature_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

campaignactivitysalesliterature_association

See campaignactivity Entity campaignactivitysalesliterature_association Many-To-Many Relationship.

campaignsalesliterature_association

See campaign Entity campaignsalesliterature_association Many-To-Many Relationship.

See also

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