Entitlement

Represents the customer support an account or contact is eligible to receive. This object is available in API version 18.0 and later. Entitlements may be based on an asset, product, or service contract.

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 when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type date Properties Filter, Nillable, Sort, Update Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Name	Type string Properties Create, Filter, Update Description Required. Name of the entitlement.
SvcApptBookingWindowsId	Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours that the entitlement’s work orders should respect. The label in the user interface is Operating Hours. Available only if Field Service is enabled.
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`.
SvcApptBookingWindows	Type reference Properties Create, Filter, Group, Sort, Nillable, Update Description The operating hours of the entitlement. This field is visible only if Field Service is enabled.
Type	Type picklist Properties Create, Defaulted on create, Filter, Nillable, Update Description The type of entitlement, such as Web or phone support.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

EntitlementFeed (API version 23.0): Feed tracking is available for the object.
EntitlementHistory: History is available for tracked fields of the object.

Object Reference for Salesforce and Lightning Platform

Entitlement

Supported Calls

Fields

Associated Objects

See Also