Entitlement

Represents the customer support an Account or Contact is eligible to receive. Entitlements may be based on an Asset, Product2, or ServiceContract.

Supported Calls

create(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Sort Description ID of the Account associated with the entitlement.
AssetId	Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the Asset associated with the entitlement. Must be a valid asset ID.
BusinessHoursId	Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the BusinessHours associated with the entitlement. Must be a valid business hours ID.
CasesPerEntitlement	Type int Properties Filter, Group, Nillable, Sort Description The total number of cases the entitlement supports. This field is only available if IsPerIncident is `true`.
ContractLineItemId	Type reference Properties Filter, Group, Nillable, Sort Description Required. ID of the ContractLineItem associated with the entitlement. Must be a valid ID.
EndDate	Type date Properties Create, Filter, Nillable, Update Description The last day the entitlement is in effect.
IsPerIncident	Type boolean Properties Defaulted on create, Filter, Update Description Indicates whether the entitlement is limited to supporting a specific number of cases (`true`) or not (`false`).
LastReferencedDate	Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type date Properties Filter, Nillable, Sort, Update Description The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name	Type string Properties Create, Filter, Update Description Required. Name of the entitlement.
RemainingCases	Type int Properties Create, Filter, Nillable, Update Description The number of cases the entitlement can support. This field decreases in value by one each time a case is created with the entitlement. This field is only available if IsPerIncident is selected.
ServiceContractId	Type reference Properties Create, Filter, Nillable, Update Description Required. ID of the ServiceContract associated with the entitlement. Must be a valid ID.
SlaProcessId	Type reference Properties Create, Filter, Nillable, Update Description ID of the SlaProcess associated with the entitlement. This field is available in version 19.0 and later.
StartDate	Type date Properties Create, Filter, Nillable, Update Description The first date the entitlement is in effect.
Status	Type picklist Properties Filter, Nillable Description Status of the entitlement, such as `Expired`.
Type	Type picklist Properties Create, Filter, Nillable, Update Description The type of entitlement, such as Web or phone support.

Usage

Use this object to query and manage entitlements.