Program

Represents information about the enrollment and disbursement of benefits in a program. This object is available in API version 57.0 and later.

Supported Calls

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

Fields

ActiveEnrolleeCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of program enrollees in Active status. This field is accessible if you enabled Data Protection and Privacy in Setup.

AdditionalContext

Type: textarea
Properties: Create, Nillable, Update
Description: The additional context about the program. This field is accessible if you enabled Data Protection and Privacy in Setup.

ApplicationFormTemplateId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The Application Form Template associated with the program. This field is a relationship field.
Relationship Name: ApplicationFormTemplate
Relationship Type: Lookup
Refers To: ApplicationFormTemplate

BusinessSector

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the business sector for the program.
Possible values:
- C&I
- Low Income
- Residential

EffectiveYear

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The year the program becomes effective.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the program is active.
Default value: false

IsRegulatoryProgram

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the program is a regulatory program.
Default value: false

ProgramDeliveryType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies if the program is delivered upstream, midstream, or downstream.
Possible values:
- Downstream
- Midstream
- Upstream

ProgramManagerId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The program manager for the program. This field is a relationship field.
Relationship Name: ProgramManager
Relationship Type: Lookup
Refers To: User

ProgramType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the type of program.
Possible values:
- Electrification
- Energy Efficiency
- Fleet Electrification
- Gasification Programs
- Low Income Programs

RegulatoryProgramName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the regulatory program.

ShortForm

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The abbreviation of the program

Stakeholder

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the stakeholders for the program.
Possible values:
- C&I
- Residential

CurrentMonthDisbCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of benefit that’s disbursed in the current month. This field is accessible if you enabled Data Protection and Privacy in Setup.

CurrentYearDisbCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of benefit that’s disbursed in the current year. This field is accessible if you enabled Data Protection and Privacy in Setup.

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the program ends. This field is accessible if you enabled Data Protection and Privacy in Setup.

EnrollmentCompletedCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of program enrollees in Completed status. This field is accessible if you enabled Data Protection and Privacy in Setup.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record, a record related to this record, or a list view.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date when the record was last viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the program.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The user who owns the object. This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

PreviousMonthDisbCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of benefit that’s disbursed in the previous month. This field is accessible if you enabled Data Protection and Privacy in Setup.

PreviousYearDisbCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The count of benefit that’s disbursed in the previous year. This field is accessible if you enabled Data Protection and Privacy in Setup.

StartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the program begins.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The status of the program. This field is accessible if you enabled Data Protection and Privacy in Setup.
Possible values:
- Active
- Cancelled
- Completed
- Planned

Summary

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The summary of the program. This field is accessible if you enabled Data Protection and Privacy in Setup.

TotalEnrolleeCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total enrollee count in the program. This field is accessible if you enabled Data Protection and Privacy in Setup.

UsageType

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the usage type of the program. Possible value is:
- ProgramManagement
This field is accessible if you enabled Data Protection and Privacy in Setup.

DefaultImageComment

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The comments about the default image that’s associated with the program.

DefaultImageUrl

Type: url
Properties: Create, Filter, Nillable, Sort, Update
Description: The URL of the default image that’s associated with the program.

Associated Objects

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 and later.

ProgramFeed: Feed tracking is available for the object.
ProgramHistory: History is available for tracked fields of the object.
ProgramOwnerSharingRule: Sharing rules are available for the object.