entitlement EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Entity Set path:[organization URI]/api/data/v8.2/entitlements

Base Type: crmbaseentity EntityType

Display Name: Entitlement

Primary Key: entitlementid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to entitlement

Operations using the entitlement entity type.

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

Name

Type

Details

allocationtypecode

Edm.Int32

Description: Select the type of entitlement terms.

Default Options:

0 : Number of cases
1 : Number of hours

Display Name: Allocation Type

createdon

Edm.DateTimeOffset

Description: Date and time when the entitlement was created.

Display Name: Created On

Read-only property

decreaseremainingon

Edm.Int32

Description: Select whether to decrease the remaining terms when the case is created or when it is resolved.

Default Options:

0 : Case Resolution
1 : Case Creation

Display Name: Decrease Remaining On

description

Edm.String

Description: Type additional information to describe the Entitlement

Display Name: Description

enddate

Edm.DateTimeOffset

Description: Enter the date when the entitlement ends.

Display Name: End Date

entitlementid

Edm.Guid

Description: Unique identifier for entity instances

Display Name: Entitlement

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

isdefault

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Is Default

kbaccesslevel

Edm.Int32

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

Default Options:

0 : Standard
1 : Premium
2 : None

Display Name: KB Access Level

modifiedon

Edm.DateTimeOffset

Description: Date and time when the record was modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Type a meaningful name for the entitlement.

Display Name: Entitlement Name

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

processid

Edm.Guid

Description: Unique identifier of the Process.

Display Name: Process

remainingterms

Edm.Decimal

Description: Type the total number of entitlement terms that are left.

Display Name: Remaining Terms

restrictcasecreation

Edm.Boolean

Description: Tells whether case creation is restricted based on entitlement terms.

Default Options:

1 : Yes
0 : No

Display Name: Restrict based on entitlement terms

stageid

Edm.Guid

Description: Unique identifier of the Stage.

Display Name: Process Stage

startdate

Edm.DateTimeOffset

Description: Enter the date when the entitlement starts.

Display Name: Start Date

statecode

Edm.Int32

Description: For internal use only.

Default Options:

0 : Draft
1 : Active
2 : Cancelled
3 : Expired
4 : Waiting

Display Name: Status

statuscode

Edm.Int32

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

Default Options:

0 : Draft
1 : Active
2 : Cancelled
3 : Expired
1200 : Waiting

Display Name: Status Code

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

totalterms

Edm.Decimal

Description: Type the total number of entitlement terms.

Display Name: Total Terms

traversedpath

Edm.String

Description: For internal use only.

Display Name: Traversed Path

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the entitlement item.

Display Name: Version Number

Read-only property

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_account

customerid_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

Enter the user or team who owns the entitlement. This field is updated every time the item is assigned to a different user.

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

account_entitlement_Account

contactid

contact EntityType

contact_entitlement_ContactId

createdby

systemuser EntityType

lk_entitlement_createdby

createdonbehalfby

systemuser EntityType

lk_entitlement_createdonbehalfby

customerid_account

account EntityType

account_entitlement_Customer

customerid_contact

contact EntityType

contact_entitlement_Customer

entitlementtemplateid

entitlementtemplate EntityType

entitlementtemplateid_RelationShip

modifiedby

systemuser EntityType

lk_entitlement_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_entitlement_modifiedonbehalfby

ownerid

principal EntityType

owner_entitlement

owningbusinessunit

businessunit EntityType

business_unit_entitlement

owningteam

team EntityType

team_entitlement

owninguser

systemuser EntityType

user_entitlement

slaid

sla EntityType

sla_entitlement

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_Entitlement

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_ActivityPointers

activitypointer EntityType

regardingobjectid_entitlement

entitlement_Annotations

annotation EntityType

objectid_entitlement

entitlement_Appointments

appointment EntityType

regardingobjectid_entitlement_appointment

entitlement_AsyncOperations

asyncoperation EntityType

regardingobjectid_entitlement

entitlement_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_entitlement

entitlement_cases

incident EntityType

entitlementid

entitlement_connections1

connection EntityType

record1id_entitlement

entitlement_connections2

connection EntityType

record2id_entitlement

entitlement_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_entitlement

entitlement_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_entitlement

entitlement_Emails

email EntityType

regardingobjectid_entitlement_email

entitlement_entitlementchannel_EntitlementId

entitlementchannel EntityType

entitlementid

entitlement_Faxes

fax EntityType

regardingobjectid_entitlement_fax

entitlement_Letters

letter EntityType

regardingobjectid_entitlement_letter

entitlement_PhoneCalls

phonecall EntityType

regardingobjectid_entitlement_phonecall

entitlement_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_entitlement_recurringappointmentmaster

entitlement_ServiceAppointments

serviceappointment EntityType

regardingobjectid_entitlement_serviceappointment

entitlement_SocialActivities

socialactivity EntityType

regardingobjectid_entitlement_socialactivity

Entitlement_SyncErrors

syncerror EntityType

regardingobjectid_entitlement_syncerror

entitlement_Tasks

task EntityType

regardingobjectid_entitlement_task

entitlementcontacts_association

contact EntityType

entitlementcontacts_association

product_entitlement_association

product EntityType

product_entitlement_association

The following operations are bound to the entitlement entity type.

Name

Bound to

RenewEntitlement Action

Entity

The following operations use the entitlement entity type in a parameter or return type.

Name

How used

Description

RenewEntitlement Action

entity Parameter

Renews an entitlement.

RenewEntitlement Action

ReturnType

Renews an entitlement.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: