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

Field	Details
ActiveEnrolleeCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of program enrollees with IsActive on ProgramEnrollment selected. This field is accessible if you activate the Program Management Data Processing Engine Definition templates 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.
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.
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
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. 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. Possible values are: `Active` `Cancelled` `Completed` `Planned` This field is accessible if you enabled Data Protection and Privacy in Setup.
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.

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.

Nonprofit Cloud Developer Guide

Program

Supported Calls

Fields

Associated Objects