FundraisingConfig

Represents a collection of settings to configure the fundraising product.

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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

FundraisingConfig components have the suffix .fundraisingConfig and are stored in the fundraisingConfigs folder.

Version 

Introduced in API version 58.0.

Special Access Rules 

Your org must have Fundraising Access license as a part of the Nonprofit Cloud to access this object.

Fields 

donorExternalIdField 

  • Type: string
  • Required: No

donorMatchingMethod 

  • Type: DonorMatchingMethod (enumeration of type string)
  • Required: No
  • Description: Reserved for future use.

failedTransactionCount 

  • Type: int
  • Required: No
  • Description: The count of consecutive failed past transactions before the gift commitment status is changed to Failing. If set to 0, the status is never auto-changed to Failing.

householdSoftCreditRole 

  • Type: string
  • Required: No
  • Description: Reserved for future use.

hshdSoftCreditExclFormula 

  • Type: string
  • Required: No

installmentExtDayCount 

  • Type: int
  • Required: No
  • Description: The duration in the number of days before or after an unpaid transaction in a gift commitment is marked as another installment in the gift commitment schedule. The unpaid transaction within the grace period is considered a gift transaction.

isHshldSoftCrAutoCrea 

  • Type: boolean
  • Required: No
  • Description: Reserved for future use.

isNextGenCmtPrcsParallel 

  • Type: boolean
  • Required: No

lapsedUnpaidTrxnCount 

  • Type: int
  • Required: No
  • Description: The count of consecutive unpaid past transactions before the gift commitment status is changed to Lapsed. If set to 0, the status is never auto-changed to Lapsed.

masterLabel 

  • Type: string
  • Required: No
  • Description: A user-friendly name for FundraisingConfig, which is defined when the FundraisingConfig is created.

nextGenCmtPrcsBatchSize 

  • Type: int
  • Required: No

nextGenCmtPrcsMaxThreads 

  • Type: int
  • Required: No

outreachSourceCodeGenFmla 

  • Type: string
  • Required: No

shouldClosePaidRcrCmt 

  • Type: boolean
  • Required: No
  • Description: Indicates whether to automatically close a recurring gift commitment when it has no ongoing or future schedule and no unpaid transaction (true) or not (false).

shouldCreateRcrSchdTrxn 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the next transaction in a recurring schedule is automatically created (true) or not (false).

utmCampaignSrcObj 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the sObject of the campaign for which the donation was received.

utmCampaignSrcObjField 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the field on the sObject in utmCampaignSrcObj of the campaign for which the donation was received.

utmMediumSrcObj 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the sObject that stores data about the message channel from which the donation originated.

utmMediumSrcObjField 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the field on the sObject in utmMediumSrcObj that stores data about the message channel from which the donation originated.

utmSourceSrcObj 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the sObject that stores data about the source of a donation.

utmSourceSrcObjField 

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Name of the field on the sObject in utmSourceSrcObj that stores data about the source of a donation.

Declarative Metadata Sample Definition 

The following is an example of a FundraisingConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<FundraisingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <lapsedUnpaidTrxnCount>5</lapsedUnpaidTrxnCount>
4    <householdSoftCreditRole>Admin</householdSoftCreditRole>
5    <isHshldSoftCrAutoCrea>true</isHshldSoftCrAutoCrea>
6    <installmentExtDayCount>7</installmentExtDayCount>
7    <donorMatchingMethod>No_Matching</donorMatchingMethod>
8    <donorExternalIdField>TestExtId__c</donorExternalIdField>
9    <failedTransactionCount>12</failedTransactionCount>
10    <outreachSourceCodeGenFmla>OutreachSourceCodeGenFmla</outreachSourceCodeGenFmla>
11    <shouldCreateRcrSchdTrxn>true</shouldCreateRcrSchdTrxn>
12    <shouldClosePaidRcrCmt>false</shouldClosePaidRcrCmt>
13    <masterLabel>MasterLabel</masterLabel>
14    <utmMediumSrcObj>UTM Medium Src Obj</utmMediumSrcObj>
15    <utmMediumSrcObjField>UTM Medium Src Obj Field</utmMediumSrcObjField>
16    <utmSourceSrcObj>UTM Source Src Obj</utmSourceSrcObj>
17    <utmSourceSrcObjField>UTM Source Src Obj Field</utmSourceSrcObjField>
18    <utmCampaignSrcObj>UTM Campaign Src Obj</utmCampaignSrcObj>
19    <utmCampaignSrcObjField>UTM Campaign Src Obj Field</utmCampaignSrcObjField>
20</FundraisingConfig>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>FundraisingConfig</name>
6    </types>
7    <version>64.0</version>
8</Package>