ProgramEnrollment

Represents details of enrollment for benefits in a program. This object is available in API version 57.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Fields

Field	Details
AccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the account that’s associated with an organization enrolled in the program. This field is accessible if you enabled Data Protection and Privacy in Setup. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
ApplicationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the enrollee applied to the program. This field is accessible if you enabled Data Protection and Privacy in Setup.
ContactId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the contact that’s associated with an individual enrolled in the program. This field is accessible if you enabled Data Protection and Privacy in Setup. This field is a relationship field. Relationship Name Contact Relationship Type Lookup Refers To Contact
CurrentMonthDisbCount	Type double Properties Create, Filter, Nillable, Sort, Update Description The count of benefit that's disbursed to the enrollee 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 to the enrollee 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 end date of the enrollment in the program. This field is accessible if you enabled Data Protection and Privacy in Setup.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the enrollment for the participant in the program is active (`true`) or not (`false`). The default value is `false`. This field is accessible if you enabled Data Protection and Privacy in Setup.
IsAnonymous	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the participant enrolled to the program anonymously (`true`) or not (`false`). The default value is `false`. 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 enrollment record.
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 to the enrollee 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 to the enrollee in the previous year. This field is accessible if you enabled Data Protection and Privacy in Setup.
ProgramId	Type reference Properties Create, Filter, Group, Sort Description The identifier of the program that's associated with the enrollee. This field is a relationship field. Relationship Name Program Relationship Type Master-Detail Refers To Program
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the enrollment in the program. This field is accessible if you enabled Data Protection and Privacy in Setup.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The enrollment status of the enrollee for the program. Possible values are: `Applied` `Completed` `Denied` `In Progress` `Waitlisted` `Withdrawn` The default value is `Applied`. 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.

ProgramEnrollmentFeed: Feed tracking is available for the object.
ProgramEnrollmentHistory: History is available for tracked fields of the object.
ProgramEnrollmentOwnerSharingRule: Sharing rules are available for the object.
ProgramEnrollmentShare: Sharing is available for the object.

Nonprofit Cloud Developer Guide

ProgramEnrollment

Supported Calls

Fields

Associated Objects