Newer Version Available

This content describes an older version of this product. View Latest

EnergyServiceAgreement

The services or commodities purchased by a customer, for a specified product and optionally linked to a Contract. Contracted Services can be physical goods (eg. appliances), commodity services (eg. electricity, gas or water) or other miscellaneous services (eg. homeowner insurance, boiler maintenance contract). This object is available in API version 62.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Account object associated with the energy service agreement. This account is financially responsible for the energy service agreement.
This field is a relationship field.
Relationship Name
Account
Refers To
Account
ActivationDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which this service was activated
BillingSchedule
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the frequency at which bills are generated such as Monthly, Quarterly or Weekly.
Possible values are:
  • Monthly
  • Quarterly
  • Weekly
ContractId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Contract object associated with the energy service agreement.
This field is a relationship field.
Relationship Name
Contract
Refers To
Contract
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date that the service agreement ends for a customer
ExternalContractIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
External identifier of the contract that governs the energy service agreement
Product2Id
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Product2 object associated with the energy service agreement.
This field is a relationship field.
Relationship Name
Product2
Refers To
Product2
StartDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date that the service agreement starts for a customer
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the service.
Possible values are:
  • Active
  • Suspended
  • Terminated
StatusChangeDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the status last changed
StatusReason
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The details describing the status of the service
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of service.
Possible values are:
  • Electricity
  • Gas
  • Water