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.

Introduced in API version 18.0.

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

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: ID of the Account associated with the entitlement.
  • Relationship name: Account
  • Relationship type: masterdetail
  • Refers to: Account
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. ID of the Asset associated with the entitlement.
  • Relationship name: Asset
  • Relationship type: relationship
  • Refers to: Asset
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The identifier of the asset warranty record. Must be a valid asset warranty ID. AssetWarranty is available only with Field Service.
  • Relationship name: AssetWarranty
  • Relationship type: relationship
  • Refers to: AssetWarranty
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. ID of the BusinessHours associated with the entitlement.
  • Relationship name: BusinessHours
  • Relationship type: relationship
  • Refers to: BusinessHours

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The total number of cases the entitlement supports.

    This field is only available if IsPerIncident is true.

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the ContractLineItem associated with the entitlement.
  • Relationship name: ContractLineItem
  • Relationship type: relationship
  • Refers to: ContractLineItem
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The last day the entitlement is in effect.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the entitlement is limited to supporting a specific number of cases (true) or not (false).
  • Default value: false
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: ID of the Location associated with the entitlement.
  • Relationship name: Location
  • Relationship type: relationship
  • Refers to: Location
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. Name of the entitlement.

  • Type: int

  • Properties: Create, Filter, Group, Nillable, Sort, 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.

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The number of agreed work orders remaining to be created.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Required. ID of the ServiceContract associated with the entitlement.
  • Relationship name: ServiceContract
  • Relationship type: relationship
  • Refers to: ServiceContract
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 19.0
  • Description: ID of the SlaProcess associated with the entitlement. This field is available in version 19.0 and later.
  • Relationship name: SlaProcess
  • Relationship type: relationship
  • Refers to: SlaProcess
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first date the entitlement is in effect.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Status of the entitlement, such as Expired.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 38.0
  • 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.
  • Relationship name: SvcApptBookingWindows
  • Relationship type: relationship
  • Refers to: OperatingHours
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The type of entitlement, such as Web or phone support.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: Total number of work orders available for this entitlement.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.