OpportunityProductRecipient

Represents a site that receives services or utilities related to an opportunity. The opportunity can be configured by one or more service points. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

OpportunityId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Required. The opportunity associated with the energy site. This field is a relationship field.
Relationship Name: Opportunity
Refers To: Opportunity

ServicePointMarketIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the service point generated by an external system.

ServiceType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of service delivered to the service point.
Possible values:
- Energy
- Gas
- Water

EstimatedAnnualConsumption

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of units of the service estimated to be consumed at the service point annually.

IsIndustryVldRequested

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether an external validation check is requested for the service point.
Default value: false

IdstVldLastRunDateTime

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date and time that an external validation was requested.

IndustryValidationStatus

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The latest response from the external validation check.

DistributionArea

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The distribution area of the service point, usually indicated using the name of the city. Example values include:
- LOND
- DERBY

ServiceAddress

Type: address
Properties: Create, Nillable, Update
Description: The address where the recipient receives the service.

UnitOfMeasureId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the measurement unit of the service, such as kWh for electricity. This field is a relationship field.
Relationship Name: UnitOfMeasure
Refers To: UnitOfMeasure