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 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.
EnrollmentCompletedCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of program enrollees in `Completed` status.

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.
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`

Nonprofit Cloud Developer Guide

Program

Supported Calls

Fields