GiftCommitmentSchedule

Represents the schedule for fulfilling the commitment. This object is available in API version 59.0 and later.

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

Supported Calls

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

Special Access Rules

This object is available only if the Fundraising Access license is enabled and the Fundraising User system permission is assigned to users.

Fields

CampaignId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The campaign associated with this gift commitment schedule. All gift transactions associated with this gift commitment schedule are associated with this campaign.

This field is a relationship field.
Relationship Name: Campaign
Relationship Type: Lookup
Refers To: Campaign

CampaignName

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The name of the campaign associated with the gift commitment schedule.

CommitmentUpdateReason

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reason the gift commitment schedule changed.
Possible values:
- Payment Method Declined
- Financial Hardship

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The end date of the new schedule for this gift commitment.

GenerationalCohort

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The generational cohort associated with the gift commitment schedule.
Possible values:
- Baby Boomers (1946-1964)
- Generation Alpha (2013-2025)
- Generation X (1965-1980)
- Generation Z (1997-2012)
- Millennials (1981-1996)
- Silent Generation (1928-1945)

GiftCommitmentId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The commitment associated with this gift commitment schedule. A value is always required in this field to save the record.

This field is a relationship field.
Relationship Name: GiftCommitment
Relationship Type: Master-Detail
Refers To: GiftCommitment

GiftCommitmentName

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The name of the related gift commitment.

GiftCommitmentSchdBefEditId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The schedule that’s associated with the current gift commitment schedule before it was edited

This field is a relationship field.
Relationship Name: GiftCommitmentSchdBefEdit
Relationship Type: Lookup
Refers To: GiftCommitmentSchedule

GiftCommitmentStatus

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Sort
Description: The status of the gift commitment that’s fulfilled by the schedule.
Default value: Draft
Possible values:
- Active
- Closed
- Draft
- Failing
- Lapsed
- Paused

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the gift commitment schedule.

OutreachSourceCodeId

Type: lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The outreach source code associated with the gift transaction.

This field is a relationship field. This field is available from API version 60.0 and later.
Relationship Name: OutreachSourceCode
Relationship Type: Lookup
Refers To: OutreachSourceCode

PaymentInstrumentId

Type: lookup
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The Payment Instrument used to complete the transaction. This field is available from API version 60.0 and later.

This field is a relationship field.
Relationship Name: PaymentInstrument
Relationship Type: Lookup
Refers To: PaymentInstrument

PaymentMethod

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The payment method for the transactions associated with this gift commitment schedule. All transactions associated with the commitment schedule default to this gift payment method.
Possible values:
- ACH
- Asset
- Cash
- Check
- Credit Card
- Cryptocurrency
- In-Kind
- PayPal
- Stock
- Unknown
- Venmo

ProcessorReference

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reference of the payment processor associated with the payment instrument. This field is available from API version 60.0 and later.

StartDate

Type: date
Properties: Create, Filter, Group, Sort, Update
Description: The start date of the new schedule for this gift commitment. A value is always required in this field to save the record.

TotalScheduleAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The expected total amount of all gift transactions associated with the gift commitment schedule.

TransactionAmount

Type: currency
Properties: Create, Filter, Sort, Update
Description: The gift amount of each transaction associated with the gift commitment schedule. A value is always required in this field to save the record.

TransactionDay

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The day of the month to create gift transaction in the future for a monthly or yearly transaction period. If you select the day as 29 or 30, the gift transaction will be created on the last day for months that don’t have that many days.

Possible values are the numbers 1 through 30 or the value LastDay.

Always required when the Transaction Period is Monthly.
Default value: 1

TransactionInterval

Type: int
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: The interval of running the gift commitment schedule. The transaction period and interval define how the schedule is run. For example, if the transaction period is monthly and the transaction interval is 3, the schedule is run after every three months.

TransactionPeriod

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: The period for which the gift commitment schedule is run. The transaction period and frequency define how the schedule is run. For example, if the transaction period is monthly and the transaction frequency is 3, the schedule is run after every three months. A value is always required in this field to save the record.
Default value: Monthly
Possible values:
- Custom
- Daily
- Monthly
- Weekly
- Yearly

Type

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Specifies the type of gift commitment schedule. A value is always required in this field to save the record.
Default value: Create Transactions
Possible values:
- Create Transactions
- Pause Transactions

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.

GiftCommitmentScheduleChangeEvent (API Version 62.0): Change events are available for the object.
GiftCommitmentScheduleFeed: Feed tracking is available for the object.
GiftCommitmentScheduleHistory: History is available for tracked fields of the object.
GiftCommitmentScheduleOwnerSharingRule (API Version 64.0): Sharing rules are available for the object.
GiftCommitmentScheduleShare (API Version 64.0): Sharing is available for the object.