FundraisingConfig | Metadata API Developer Guide

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 the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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

Version

FundraisingConfig components are available in API version 58.0 and later.

Special Access Rules

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

Fields

Field Name	Description
donorMatchingMethod	Field Type DonorMatchingMethod (enumeration of type string) Description Reserved for future use.
failedTransactionCount	Field Type int 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	Field Type string Description Reserved for future use.
installmentExtDayCount	Field Type int 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	Field Type boolean Description Reserved for future use.
lapsedUnpaidTrxnCount	Field Type int 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	Field Type string Description A user-friendly name for FundraisingConfig, which is defined when the FundraisingConfig is created.
shouldClosePaidRcrCmt	Field Type boolean 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`). The default value is `false`. Available in API version 59.0 and later.
shouldCreateRcrSchdTrxn	Field Type boolean Description Indicates whether the next transaction in a recurring schedule is automatically created (`true`) or not (`false`). The default value is `true`. Available in API version 59.0 and later.

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    <failedTransactionCount>12</failedTransactionCount>
9    <shouldCreateRcrSchdTrxn>true</shouldCreateRcrSchdTrxn>
10    <shouldClosePaidRcrCmt>false</shouldClosePaidRcrCmt>
11    <masterLabel>MasterLabel</masterLabel>
12</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>59.0</version>
8</Package>