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
Case Management
Case Management Standard Objects
CarePlan
CarePlanTemplate
CarePlanTemplateBenefit
CarePlanTemplateGoal
CaseParticipant
ComplaintCase
ComplaintParticipant
GoalAssignment
GoalDefinition
Interaction
InteractionAttendee
InteractionRelatedAccount
InteractionSummary
InteractionSumDiscussedAccount
PublicComplaint
Referral
Case Management Business API
Outcome Management Standard Objects
Grantmaking
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

GoalAssignment

Represents the assignment of a goal. This object is available in API version 55.0 and later.

Supported Calls

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

Special Access Rules

This object is available if Program and Benefit Management is enabled in your org. To access the object, you need the Program and Benefit Management Access permission set or the Program and Benefit Management permission set license.

Fields

Field Details
CompletionDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the goal is completed.
CompletionPercentage
Type
percent
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Indicates the progress made on the assigned goal in percentage.
CustomGoalName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A custom name that can be defined for the goal assignment. If this field is empty, the goal definition name is used for the goal assignment.
This field is available from API version 63.0 and later.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the goal assignment record.
GoalAssigneeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The assigees associated with the goal assignment.
This is a polymorphic relationship field.
Relationship Name
GoalAssignee
Relationship Type
Lookup
Refers To
Account, Contact
GoalDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The goal definition associated with the goal assignment.
This is a relationship field.
Relationship Name
GoalDefinition
Relationship Type
Lookup
Refers To
GoalDefinition
DescriptionCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents the description of a standardized goal.
This field is a polymorphic relationship field.
Available in API version 61.0 and later.
Relationship Name
DescriptionCode
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
GoalType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Specifies if the goal applies to a group or an individual.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the goal assignment record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the goal assignment record owner.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParentRecordId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The care plan or benefit assignment object associated with the goal assignment.
This is a polymorphic relationship field.
Relationship Name
ParentRecord
Relationship Type
Lookup
Refers To
BenefitAssignment, CarePlan
Priority
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the priority of the goal assignment.
Possible values are:
  • High
  • Low
  • Medium
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date of the assigned goal.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the assigned goal.
Possible values are:
  • Canceled
  • Completed
  • In Progress
  • Not Started
The default value is 'Not Started'.
TargetCompletionDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date by when the assigned goal is targeted to be completed.

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.

GoalAssignmentFeed
Feed tracking is available for the object.
GoalAssignmentHistory
History is available for tracked fields of the object.
GoalAssignmentOwnerSharingRule
Sharing rules are available for the object.
GoalAssignmentShare
Sharing is available for the object.