The Goal
object contains information related to a fundraising goal in Neon Fundraise. This could be a campaign goal, a team page/goal, a personal fundraising page/goal, or a national team goal.
Availability: The Goal
object is available primarily as the Recipient
on the Donation
object and is consequently available wherever the donation object is available, excluding the PDF Receipt template. Due to the fact that Recipient
is the only forward-facing instance of the Goal
object, we will refer to the object here as Recipient
.
Attributes: The Goal object has the following attributes:
- Recipient.Type
- Recipient.Name
- Recipient.Goal_Amount
- Recipient.Amount_Raised
- Recipient.Amount_To_Goal
- Recipient.Amount_Raised_Without_Champion
- Recipient.Amount_To_Goal_Without_Champion
- Recipient.Page
- Recipient.National_Team_Id
Recipient.Type
Returns the goal/campaign type. Possible values are:
- Campaign
- Team
- Fundraiser
- National Team
Recipient.Name
Returns the goal/campaign name. Depending on Recipient.Type
, this can be the campaign name, team name, or fundraiser name.
Recipient.Goal_Amount
Returns the goal/campaign's goal amount. Use a money
filter to return the value in a monetary format:
{{ Recipient.Goal_Amount | money
}}
$10,000
Recipient.Amount_Raised
Returns the amount raised by the goal/campaign. For Champion parent campaigns and Champion fundraisers, this includes the amount raised on Champion campaigns (see more). Use a money
filter to return the value in a monetary format:
{{ Recipient.Amount_Raised | money
}}
$9,362.00
Recipient.Amount_To_Goal
Returns the difference between the goal/campaign's total raised and goal amount. For Champion parent campaigns and Champion fundraisers, this includes the amount raised on Champion campaigns (see more). Use a money
filter to return the value in a monetary format:
{{ Recipient.Amount_To_Goal | money
}}
$638.00
Recipient.Amount_Raised_Without_Champion
Applies to Champion parent campaigns and Champion fundraisers. Returns the amount raised by the campaign or Champion alone, excluding the amount raised from related Champion campaigns (see more).
Recipient.Amount_To_Goal_Without_Champion
Applies to Champion parent campaigns and Champion fundraisers. Returns the the difference between the campaign or Champion's goal amount and total raised, the latter excluding the amount raised from related Champion campaigns (see more).
Recipient.Page
Returns a link that, depending on Recipient.Type
, directs to the personal or team fundraising page, or campaign homepage.
Recipient.National_Team_Id
Returns the ID of an associated national team.