Skip to main content

Fundraise Up Mapping Functions

Reference for the Fundraise Up-specific functions you can use in Dynamic Formula mappings and mapping collection filters.

Overview

The Fundraise Up integration provides a set of ready-made functions you can call when building mappings. They handle common conversions for Fundraise Up data, such as turning a recurring frequency or donation status code into a readable label, reading the donor's answer to a checkout question and reading a value from a custom field, so you do not have to write that logic yourself in a formula.

Where you can use these functions

These functions are available anywhere you write a formula for the Fundraise Up integration:

  • Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.

  • Mapping collection filters: where a formula decides whether a record should be processed.

  • Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.

  • Translation collections: where a translation entry uses a formula as its source value.

How to use them

  • Call a function by name and pass the values it needs in parentheses, for example: FormatDonationStatus(statusCode).

  • Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.

  • Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.

  • These functions are synchronous, so you call them directly (no await is required).

  • Optional parameters are marked in the parameter table, along with the value used when you omit them.

  • Each function runs at sync time, against the data in your connected Fundraise Up account and your iPaaS.com subscription.

The functions are grouped below by the area of the integration they support.

Donations

FormatRecurringFrequency

What it does: Converts a Fundraise Up recurring plan frequency code into a readable label, such as turning every4weeks into Every 4 Weeks.

Signature: string FormatRecurringFrequency(string frequencyCode)

How to call it: FormatRecurringFrequency(frequencyCode)

Parameter

Type

Required

Default

Description

frequencyCode

string

Yes

N/A

The frequency code from the Fundraise Up recurring plan, such as monthly, annual, or every4weeks. The match is case-insensitive. The recognized codes are daily, weekly, biweekly, every4weeks, monthly, bimonthly, quarterly, semiannual and annual. yearly is also recognized (Yearly) so older mappings keep working; Fundraise Up does not send it.

Returns: string. The readable frequency label. An unrecognized code is returned unchanged so new Fundraise Up values are not lost, and an empty input returns null.

Example: "every4weeks" returns "Every 4 Weeks".

When to use it: Use this in a mapping to show a recurring plan cadence in readable form on a transaction or report rather than the raw code.

FormatDonationStatus

What it does: Converts a Fundraise Up donation status code into a readable label, such as turning succeeded into Succeeded.

Signature: string FormatDonationStatus(string statusCode)

How to call it: FormatDonationStatus(statusCode)

Parameter

Type

Required

Default

Description

statusCode

string

Yes

N/A

The status code from the Fundraise Up donation, such as succeeded, failed, refunded, or retrying. The match is case-insensitive. The recognized codes are succeeded, failed, refunded, pending, retrying and scheduled.

Returns: string. The readable status label. An unrecognized code is returned unchanged so new Fundraise Up values are not lost, and an empty input returns null.

Example: "succeeded" returns "Succeeded".

When to use it: Use this in a mapping to show a donation status in readable form on a transaction or report. To translate the status to the iPaaS.com transaction status taxonomy, use the integration's shipped Status lookup translation instead.

GetQuestionAnswer

What it does: Reads the donor's answer to a Fundraise Up custom question from the donation's Questions list.

Signature: string GetQuestionAnswer(object questions, object questionCode, object delimiter = null)

How to call it: GetQuestionAnswer(questions, questionCode)

Parameter

Type

Required

Default

Description

questions

object

Yes

N/A

The Fundraise Up donation's Questions list.

questionCode

object

Yes

N/A

The question's code as configured in Fundraise Up. If no question has that code, the Fundraise Up question with that ID is used.

delimiter

object

No

null

The text placed between the selected options of a multi-select question. When omitted or null, ", " (a comma and a space) is used.

Returns: string. The free-text or single-select answer; the selected options joined with delimiter for a multi-select question; "true" or "false" for a checkbox question. null when the question is not on the donation or was left unanswered.

Example: GetQuestionAnswer(Questions, "how_did_you_hear", "; ") returns "Friend or family" for a single-select answer, or "Email; Social media" for a multi-select one.

When to use it: Use this to carry a checkout question's answer onto a Transaction custom field (in the Donation collection). It is the only way to reach donation question answers: the default template does not map them (see Fundraise Up Known Limitations). Fundraise Up sends the option label, not a code, so a destination that expects coded values needs a lookup translation after this function.

Custom Fields

GetValueFromCustomField

What it does: Reads the value of a named Fundraise Up custom field from a donation, or a named value from a Fundraise Up record.

Signature: object GetValueFromCustomField(object customFieldObj, object textFieldName)

How to call it: GetValueFromCustomField(customFieldObj, textFieldName)

Parameter

Type

Required

Default

Description

customFieldObj

object

Yes

N/A

The object that holds the value. Pass CustomFields for a Fundraise Up donation custom field; the list is searched by the field's Name. Any other object is searched by key; pass AdditionalProperties only for a Fundraise Up value the mapping editor does not list as a field.

textFieldName

object

Yes

N/A

The name of the field to read: the Name of the Fundraise Up custom field when customFieldObj is CustomFields (matched exactly, including case), or the key of the Fundraise Up API value when it is AdditionalProperties.

Returns: object. The value of the named field, or null (not an error) if the field is missing or has no value. A value read from CustomFields comes back as text, so true and false arrive as lowercase "true" and "false"; with two fields of the same name, the first one's value is returned. A value read from any other object keeps its original type.

Example: GetValueFromCustomField(CustomFields, "utm_partner") returns the value of the Fundraise Up custom field named utm_partner, for example "spring-mailer".

When to use it: Use this to pull a single custom-field value into a mapping by its field name.

Related Documents

Did this answer your question?