Nonprofit Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Program Management
Program Management Standard Objects
Benefit
BenefitAssignment
BenefitDisbursement
BenefitSchedule
BenefitScheduleAssignment
BenefitSession
BenefitType
CaseProgram
Program
ProgramCohort
ProgramCohortMember
ProgramEnrollment
RecurrenceSchedule
Program Management Business APIs
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

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 ID of the account that’s associated with an organization enrolled in the program.
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.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the contact that’s associated with an individual enrolled in the program.
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 benefits disbursed to the enrollee in the current month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.
CurrentYearDisbCount
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The count of benefits disbursed to the enrollee in the current year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The end date of the enrollment in the program.
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.
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.
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.
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 disbursed to the enrollee in the previous month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.
PreviousYearDisbCount
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The count of benefits disbursed to the enrollee in the previous year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.
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.
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.

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.