Program

Represents information about the enrollment and disbursement of benefits in a program.

Supported Calls

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

Fields

Field	Details
ActiveEnrolleeCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of program enrollees in active status.
AdditionalContext	Type textarea Properties Create, Nillable, Update Description The additional context about the program.
CurrentMonthDisbCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of benefit that's disbursed in the current month.
CurrentYearDisbCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of benefit that's disbursed in the current year.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the program ends.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Required. The name of the program.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
ParentProgramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The associated parent program. This field is available from API version 59.0 and later. This field is a relationship field. Relationship Name ParentProgram Relationship Type Lookup Refers To Program
PreviousMonthDisbCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of benefit that's disbursed in the previous month.
PreviousYearDisbCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of benefit that's disbursed in the previous year.
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. Possible values are: `Active` `Cancelled` `Completed` `Planned`
Summary	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The summary of the program.
TotalEnrolleeCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The total enrollee count in the program.
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the usage type of the program. Possible value is: `ProgramManagement`

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.
ProgramShare: Sharing is available for the object.

Public Sector Solutions Developer Guide

Program

Supported Calls

Fields

Associated Objects