entitlement EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/entitlements
Base Type
Display Name
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 the type of entitlement terms.

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

Select 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 Entitlement

Display Name: Description

emailaddress Edm.String

The primary email address for the entity.

Display Name: Email Address

enddate Edm.DateTimeOffset

Enter the date when the entitlement ends.

Display Name: End Date

entitlementid Edm.Guid

Unique identifier for entity instances

Display Name: Entitlement

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

isdefault Edm.Boolean

Shows whether this entitlement is the default one for the specified customer.

Display Name: Is Default

Default Options
Value Label
1 Yes
0 No
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 meaningful name for the entitlement.

Display Name: Entitlement Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

remainingterms Edm.Decimal

Type the total number of entitlement terms that are left.

Display Name: Remaining Terms

restrictcasecreation Edm.Boolean

Tells whether case creation is restricted based on entitlement terms.

Display Name: Restrict based on entitlement terms

Default Options
Value Label
1 Yes
0 No
stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

startdate Edm.DateTimeOffset

Enter the date when the entitlement starts.

Display Name: Start Date

statecode Edm.Int32

For internal use only.

Display Name: Status

Default Options
Value Label
0 Draft
1 Active
2 Cancelled
3 Expired
4 Waiting
statuscode Edm.Int32

Select the reason code that explains the status of the entitlement.

Display Name: Status Code

Default Options
Value Label
0 Draft
1 Active
2 Cancelled
3 Expired
1200 Waiting
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

traversedpath Edm.String

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.

Display Name: Traversed Path

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
_accountid_value accountid

Unique identifier for Account associated with Entitlement.

_contactid_value contactid

Unique identifier for Contact associated with Entitlement.

_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the entitlement.

_customerid_value customerid_accountcustomerid_contact

Choose a contact or account for which this entitlement has been defined.

_entitlementtemplateid_value entitlementtemplateid

Unique identifier for Entitlement Template associated with Entitlement.

_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.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_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
accountid account account_entitlement_Account
contactid contact contact_entitlement_ContactId
createdby systemuser lk_entitlement_createdby
createdonbehalfby systemuser lk_entitlement_createdonbehalfby
customerid_account account account_entitlement_Customer
customerid_contact contact contact_entitlement_Customer
entitlementtemplateid entitlementtemplate entitlementtemplateid_RelationShip
modifiedby systemuser lk_entitlement_modifiedby
modifiedonbehalfby systemuser lk_entitlement_modifiedonbehalfby
ownerid principal owner_entitlement
owningbusinessunit businessunit business_unit_entitlement
owningteam team team_entitlement
owninguser systemuser user_entitlement
slaid sla sla_entitlement
transactioncurrencyid transactioncurrency TransactionCurrency_Entitlement

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
entitlement_ActivityParties activityparty partyid_entitlement
entitlement_ActivityPointers activitypointer regardingobjectid_entitlement
entitlement_Annotations annotation objectid_entitlement
entitlement_Appointments appointment regardingobjectid_entitlement_appointment
entitlement_AsyncOperations asyncoperation regardingobjectid_entitlement
entitlement_BulkDeleteFailures bulkdeletefailure regardingobjectid_entitlement
entitlement_cases incident entitlementid
entitlement_connections1 connection record1id_entitlement
entitlement_connections2 connection record2id_entitlement
entitlement_DuplicateBaseRecord duplicaterecord baserecordid_entitlement
entitlement_DuplicateMatchingRecord duplicaterecord duplicaterecordid_entitlement
entitlement_Emails email regardingobjectid_entitlement_email
entitlement_entitlementchannel_EntitlementId entitlementchannel entitlementid
entitlement_Faxes fax regardingobjectid_entitlement_fax
entitlement_IncidentResolutions incidentresolution regardingobjectid_entitlement_incidentresolution
entitlement_Letters letter regardingobjectid_entitlement_letter
Entitlement_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_entitlement
entitlement_msdyn_approvals msdyn_approval regardingobjectid_entitlement_msdyn_approval
entitlement_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_entitlement_msdyn_bookingalert
entitlement_OpportunityCloses opportunityclose regardingobjectid_entitlement_opportunityclose
entitlement_OrderCloses orderclose regardingobjectid_entitlement_orderclose
entitlement_PhoneCalls phonecall regardingobjectid_entitlement_phonecall
entitlement_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_entitlement
entitlement_ProcessSession processsession regardingobjectid_entitlement
entitlement_QuoteCloses quoteclose regardingobjectid_entitlement_quoteclose
entitlement_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_entitlement_recurringappointmentmaster
entitlement_ServiceAppointments serviceappointment regardingobjectid_entitlement_serviceappointment
entitlement_SocialActivities socialactivity regardingobjectid_entitlement_socialactivity
Entitlement_SyncErrors syncerror regardingobjectid_entitlement_syncerror
entitlement_Tasks task regardingobjectid_entitlement_task
entitlementcontacts_association contact entitlementcontacts_association
product_entitlement_association product product_entitlement_association


The following operations can be used with the entitlement entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RenewEntitlement Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound


The following solutions include the entitlement entity type.

Name Description
CRM Extensions For internal use only.
Service Dynamics 365 workload for service.

See also