Entitlement Entity Reference

Defines the amount and type of support a customer should receive.

Added by: Service Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/entitlements(entitlementid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/entitlements
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/entitlements(entitlementid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
RenewEntitlement RenewEntitlement Action RenewEntitlementRequest
Retrieve GET [org URI]/api/data/v9.0/entitlements(entitlementid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/entitlements
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/entitlements(entitlementid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/entitlements(entitlementid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Entitlements
DisplayCollectionName Entitlements
DisplayName Entitlement
EntitySetName entitlements
IsBPFEntity False
LogicalCollectionName entitlements
LogicalName entitlement
OwnershipType UserOwned
PrimaryIdAttribute entitlementid
PrimaryNameAttribute name
SchemaName Entitlement

Writable attributes

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

AllocationTypeCode

Property Value
Description Select the type of entitlement terms.
DisplayName Allocation Type
IsValidForForm True
IsValidForRead True
LogicalName allocationtypecode
RequiredLevel ApplicationRequired
Type Picklist

AllocationTypeCode Options

Value Label
0 Number of cases
1 Number of hours

CustomerId

Property Value
Description Choose a contact or account for which this entitlement has been defined.
DisplayName Customer
IsValidForForm True
IsValidForRead True
LogicalName customerid
RequiredLevel SystemRequired
Targets account,contact
Type Customer

CustomerIdType

Property Value
Description
DisplayName Customer Type
IsValidForForm False
IsValidForRead True
LogicalName customeridtype
RequiredLevel ApplicationRequired
Type EntityName

DecreaseRemainingOn

Property Value
Description Select whether to decrease the remaining terms when the case is created or when it is resolved.
DisplayName Decrease Remaining On
IsValidForForm True
IsValidForRead True
LogicalName decreaseremainingon
RequiredLevel ApplicationRequired
Type Picklist

DecreaseRemainingOn Options

Value Label
0 Case Resolution
1 Case Creation

Description

Property Value
Description Type additional information to describe the Entitlement
DisplayName Description
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EmailAddress

Property Value
Description The primary email address for the entity.
DisplayName Email Address
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EndDate

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the entitlement ends.
DisplayName End Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName enddate
RequiredLevel SystemRequired
Type DateTime

EntitlementId

Property Value
Description Unique identifier for entity instances
DisplayName Entitlement
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName entitlementid
RequiredLevel SystemRequired
Type Uniqueidentifier

EntitlementTemplateId

Property Value
Description Unique identifier for Entitlement Template associated with Entitlement.
DisplayName Entitlement Template
IsValidForForm True
IsValidForRead True
LogicalName entitlementtemplateid
RequiredLevel None
Targets entitlementtemplate
Type Lookup

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

IsDefault

Property Value
Description Shows whether this entitlement is the default one for the specified customer.
DisplayName Is Default
IsValidForForm True
IsValidForRead True
LogicalName isdefault
RequiredLevel ApplicationRequired
Type Boolean

IsDefault Options

Value Label
1 Yes
0 No

DefaultValue: False

KbAccessLevel

Property Value
Description Select the access someone will have to the knowledge base on the portal.
DisplayName KB Access Level
IsValidForForm True
IsValidForRead True
LogicalName kbaccesslevel
RequiredLevel None
Type Picklist

KbAccessLevel Options

Value Label
0 Standard
1 Premium
2 None

Name

Property Value
Description Type a meaningful name for the entitlement.
DisplayName Entitlement Name
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

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel None
Type EntityName

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

RemainingTerms

Property Value
Description Type the total number of entitlement terms that are left.
DisplayName Remaining Terms
IsValidForForm True
IsValidForRead True
LogicalName remainingterms
MaxValue 100000000000
MinValue -100000000000
Precision 2
RequiredLevel None
Type Decimal

RestrictCaseCreation

Property Value
Description Tells whether case creation is restricted based on entitlement terms.
DisplayName Restrict based on entitlement terms
IsValidForForm True
IsValidForRead True
LogicalName restrictcasecreation
RequiredLevel ApplicationRequired
Type Boolean

RestrictCaseCreation Options

Value Label
1 Yes
0 No

DefaultValue: False

SLAId

Property Value
Description Choose the service level agreement (SLA) associated with the entitlement.
DisplayName SLA
IsValidForForm True
IsValidForRead True
LogicalName slaid
RequiredLevel None
Targets sla
Type Lookup

StageId

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

StartDate

Property Value
DateTimeBehavior UserLocal
Description Enter the date when the entitlement starts.
DisplayName Start Date
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName startdate
RequiredLevel SystemRequired
Type DateTime

StateCode

Property Value
Description For internal use only.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel None
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Draft 0 Draft
1 Active 1 Active
2 Cancelled 2 Cancelled
3 Expired 3 Expired
4 Waiting 1200 Waiting

StatusCode

Property Value
Description Select the reason code that explains the status of the entitlement.
DisplayName Status Code
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
0 Draft 0
1 Active 1
2 Cancelled 2
3 Expired 3
1200 Waiting 4

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

TotalTerms

Property Value
Description Type the total number of entitlement terms.
DisplayName Total Terms
IsValidForForm True
IsValidForRead True
LogicalName totalterms
MaxValue 100000000000
MinValue 0
Precision 2
RequiredLevel None
Type Decimal

TransactionCurrencyId

Property Value
Description Unique identifier of the currency associated with the contact.
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 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.

AccountId

Property Value
Description Unique identifier for Account associated with Entitlement.
DisplayName Account
IsValidForForm False
IsValidForRead True
LogicalName accountid
RequiredLevel None
Targets account
Type Lookup

AccountIdName

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

AccountIdYomiName

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

ContactId

Property Value
Description Unique identifier for Contact associated with Entitlement.
DisplayName Contact
IsValidForForm False
IsValidForRead True
LogicalName contactid
RequiredLevel None
Targets contact
Type Lookup

ContactIdName

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

ContactIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName contactidyominame
MaxLength 100
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 None
Type String

CreatedOn

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

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the entitlement.
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

CustomerIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customeridname
MaxLength 160
RequiredLevel ApplicationRequired
Type String

CustomerIdYomiName

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

EntitlementTemplateIdName

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

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the contact with respect to the base 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 None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateOnly
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 None
Type String

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel None
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel None
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

SLAIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName slaidname
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.

entitlement_ActivityPointers

Same as activitypointer entity entitlement_ActivityPointers Many-To-One relationship.

Property Value
ReferencingEntity activitypointer
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_ActivityPointers
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Entitlement_SyncErrors

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

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

entitlement_ActivityParties

Same as activityparty entity entitlement_ActivityParties Many-To-One relationship.

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

entitlement_AsyncOperations

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

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

Entitlement_MailboxTrackingFolder

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

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

entitlement_UserEntityInstanceDatas

Same as userentityinstancedata entity entitlement_UserEntityInstanceDatas Many-To-One relationship.

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

entitlement_ProcessSession

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

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

entitlement_BulkDeleteFailures

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

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

entitlement_PrincipalObjectAttributeAccesses

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

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

entitlement_Appointments

Same as appointment entity entitlement_Appointments Many-To-One relationship.

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

entitlement_Emails

Same as email entity entitlement_Emails Many-To-One relationship.

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

entitlement_Faxes

Same as fax entity entitlement_Faxes Many-To-One relationship.

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

entitlement_Letters

Same as letter entity entitlement_Letters Many-To-One relationship.

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

entitlement_PhoneCalls

Same as phonecall entity entitlement_PhoneCalls Many-To-One relationship.

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

entitlement_Tasks

Same as task entity entitlement_Tasks Many-To-One relationship.

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

entitlement_RecurringAppointmentMasters

Same as recurringappointmentmaster entity entitlement_RecurringAppointmentMasters Many-To-One relationship.

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

entitlement_SocialActivities

Same as socialactivity entity entitlement_SocialActivities Many-To-One relationship.

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

entitlement_connections1

Same as connection entity entitlement_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlement_connections2

Same as connection entity entitlement_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_connections2
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlement_Annotations

Same as annotation entity entitlement_Annotations Many-To-One relationship.

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

entitlement_IncidentResolutions

Same as incidentresolution entity entitlement_IncidentResolutions Many-To-One relationship.

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

entitlement_ServiceAppointments

Same as serviceappointment entity entitlement_ServiceAppointments Many-To-One relationship.

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

entitlement_cases

Same as incident entity entitlement_cases Many-To-One relationship.

Property Value
ReferencingEntity incident
ReferencingAttribute entitlementid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_cases
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlement_entitlementchannel_EntitlementId

Same as entitlementchannel entity entitlement_entitlementchannel_EntitlementId Many-To-One relationship.

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

entitlement_DuplicateBaseRecord

Same as duplicaterecord entity entitlement_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlement_DuplicateMatchingRecord

Same as duplicaterecord entity entitlement_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName entitlement_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlement_OpportunityCloses

Same as opportunityclose entity entitlement_OpportunityCloses Many-To-One relationship.

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

entitlement_OrderCloses

Same as orderclose entity entitlement_OrderCloses Many-To-One relationship.

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

entitlement_QuoteCloses

Same as quoteclose entity entitlement_QuoteCloses Many-To-One relationship.

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

entitlement_msdyn_bookingalerts

Same as msdyn_bookingalert entity entitlement_msdyn_bookingalerts Many-To-One relationship.

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

entitlement_msdyn_approvals

Same as msdyn_approval entity entitlement_msdyn_approvals Many-To-One relationship.

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

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_entitlement_createdby

See systemuser Entity lk_entitlement_createdby One-To-Many relationship.

lk_entitlement_createdonbehalfby

See systemuser Entity lk_entitlement_createdonbehalfby One-To-Many relationship.

lk_entitlement_modifiedby

See systemuser Entity lk_entitlement_modifiedby One-To-Many relationship.

lk_entitlement_modifiedonbehalfby

See systemuser Entity lk_entitlement_modifiedonbehalfby One-To-Many relationship.

user_entitlement

See systemuser Entity user_entitlement One-To-Many relationship.

team_entitlement

See team Entity team_entitlement One-To-Many relationship.

business_unit_entitlement

See businessunit Entity business_unit_entitlement One-To-Many relationship.

processstage_Entitlement

See processstage Entity processstage_Entitlement One-To-Many relationship.

account_entitlement_Account

See account Entity account_entitlement_Account One-To-Many relationship.

account_entitlement_Customer

See account Entity account_entitlement_Customer One-To-Many relationship.

contact_entitlement_ContactId

See contact Entity contact_entitlement_ContactId One-To-Many relationship.

contact_entitlement_Customer

See contact Entity contact_entitlement_Customer One-To-Many relationship.

entitlementtemplateid_RelationShip

See entitlementtemplate Entity entitlementtemplateid_RelationShip One-To-Many relationship.

sla_entitlement

See sla Entity sla_entitlement One-To-Many relationship.

TransactionCurrency_Entitlement

See transactioncurrency Entity TransactionCurrency_Entitlement One-To-Many relationship.

Many-To-Many Relationships

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

entitlementcontacts_association

See contact Entity entitlementcontacts_association Many-To-Many Relationship.

product_entitlement_association

See product Entity product_entitlement_association Many-To-Many Relationship.

See also

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