entitlementtemplate EntityType

Contains predefined customer support terms that can be used to created entitlements for customers.

Entity Set Path
[organization URI]/api/data/v9.0/entitlementtemplates
Base Type
Display Name
Entitlement Template
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
allocationtypecode Edm.Int32

Select whether the entitlement allocation is based on number of cases or number of hours.

Display Name: Allocation Type

Default Options
Value Label
0 Number of cases
1 Number of hours
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
decreaseremainingon Edm.Int32

Information about whether to decrease the remaining terms when the case is created or when it is resolved

Display Name: Decrease Remaining On

Default Options
Value Label
0 Case Resolution
1 Case Creation
description Edm.String

Type additional information to describe the account, such as an excerpt from the company's website.

Display Name: Description

enddate Edm.DateTimeOffset

Enter the date and time when the entitlement ends.

Display Name: End Date

entitlementtemplateid Edm.Guid

Unique identifier for entity instances

Display Name: Entitlement Template

entitytype Edm.Int32

Entity type for which the entitlement template applies

Display Name: Entity Type

Default Options
Value Label
0 Case
192350000 Work Order
exchangerate Edm.Decimal

Exchange rate for the currency associated with the contact with respect to the base currency.

Display Name: Exchange Rate

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

kbaccesslevel Edm.Int32

Select the access someone will have to the knowledge base on the portal.

Display Name: KB Access Level

Default Options
Value Label
0 Standard
1 Premium
2 None
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

Type a descriptive name for the entitlement template.

Display Name: Entitlement Template Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

restrictcasecreation Edm.Boolean

Tells whether case creation is restricted based on entitlement terms.

Display Name: Restrict By Entitlement Terms

Default Options
Value Label
1 Yes
0 No
startdate Edm.DateTimeOffset

Enter the date and time when the entitlement begins.

Display Name: Start Date

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

totalterms Edm.Decimal

Type the total number of entitlement terms.

Display Name: Total Terms

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_organizationid_value organizationid

Unique identifier for the organization

_slaid_value slaid

Choose the service level agreement (SLA) associated with the entitlement.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the contact.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_entitlementtemplate_createdby
createdonbehalfby systemuser lk_entitlementtemplate_createdonbehalfby
modifiedby systemuser lk_entitlementtemplate_modifiedby
modifiedonbehalfby systemuser lk_entitlementtemplate_modifiedonbehalfby
organizationid organization entitlementtemplate_organization
slaid sla sla_entitlementtemplate
transactioncurrencyid transactioncurrency TransactionCurrency_entitlementtemplate

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
entitlementtemplate_ActivityPointers activitypointer regardingobjectid_entitlementtemplate
entitlementtemplate_Annotations annotation objectid_entitlementtemplate
entitlementtemplate_Appointments appointment regardingobjectid_entitlementtemplate_appointment
entitlementtemplate_AsyncOperations asyncoperation regardingobjectid_entitlementtemplate
entitlementtemplate_BulkDeleteFailures bulkdeletefailure regardingobjectid_entitlementtemplate
entitlementtemplate_DuplicateBaseRecord duplicaterecord baserecordid_entitlementtemplate
entitlementtemplate_DuplicateMatchingRecord duplicaterecord duplicaterecordid_entitlementtemplate
entitlementtemplate_Emails email regardingobjectid_entitlementtemplate_email
entitlementtemplate_entitlementchannel_entitlementtemplateid entitlementtemplatechannel entitlementtemplateid
entitlementtemplate_Faxes fax regardingobjectid_entitlementtemplate_fax
entitlementtemplate_IncidentResolutions incidentresolution regardingobjectid_entitlementtemplate_incidentresolution
entitlementtemplate_Letters letter regardingobjectid_entitlementtemplate_letter
EntitlementTemplate_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_entitlementtemplate
entitlementtemplate_msdyn_approvals msdyn_approval regardingobjectid_entitlementtemplate_msdyn_approval
entitlementtemplate_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_entitlementtemplate_msdyn_bookingalert
entitlementtemplate_OpportunityCloses opportunityclose regardingobjectid_entitlementtemplate_opportunityclose
entitlementtemplate_OrderCloses orderclose regardingobjectid_entitlementtemplate_orderclose
entitlementtemplate_PhoneCalls phonecall regardingobjectid_entitlementtemplate_phonecall
entitlementtemplate_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_entitlementtemplate
entitlementtemplate_ProcessSession processsession regardingobjectid_entitlementtemplate
entitlementtemplate_QuoteCloses quoteclose regardingobjectid_entitlementtemplate_quoteclose
entitlementtemplate_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_entitlementtemplate_recurringappointmentmaster
entitlementtemplate_ServiceAppointments serviceappointment regardingobjectid_entitlementtemplate_serviceappointment
entitlementtemplate_SocialActivities socialactivity regardingobjectid_entitlementtemplate_socialactivity
EntitlementTemplate_SyncErrors syncerror regardingobjectid_entitlementtemplate_syncerror
entitlementtemplate_Tasks task regardingobjectid_entitlementtemplate_task
entitlementtemplateid_RelationShip entitlement entitlementtemplateid
product_entitlementtemplate_association product product_entitlementtemplate_association


The following solutions include the entitlementtemplate entity type.

Name Description
Service Dynamics 365 workload for service.
Service Patch Patch for Dynamics 365 workload for service.
Service Dynamics 365 workload for service.

See also