GiftCommitment

Represents the commitment made by a donor. This object is available in API version 59.0 and later.

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

Field	Details
CampaignId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The campaign associated with this commitment. This field is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign
CurrentGiftCmtScheduleId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The current, active schedule of the commitment. This field is a relationship field. Relationship Name CurrentGiftCmtSchedule Relationship Type Lookup Refers To GiftCommitmentSchedule
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description about the gift commitment.
DonorId	Type reference Properties Create, Filter, Group, Sort, Update Description The person, household, or organization account associated with this commitment. This field is a relationship field. Relationship Name Donor Relationship Type Lookup Refers To Account
EffectiveStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date from when the commitment is in effect.
EffectiveTransactionInterval	Type int Properties Filter, Group, Nillable, Sort Description The transaction interval that's applicable based on the currently active schedule.
EffectiveTransactionPeriod	Type string Properties Filter, Group, Nillable, Sort Description The transaction period that's applicable based on the currently active schedule.
ExpectedAssetMaturityDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The expected maturity date of all the committed assets for a commitment.
ExpectedAssetTransferDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The expected date of transferring all the committed assets for a commitment.
ExpectedEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the total amount of the commitment is expected to be fully paid.
ExpectedTotalCmtAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total donation amount that's expected for this commitment.
FormalCommitmentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the formality type of the commitment. Possible values are: `Verbal` `Written` The default value is `Verbal`.
FulfillmentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies whether the commitment fulfillment depends on one or more conditions or is unconditional. Possible values are: `Conditional` `Unconditional` The default value is `Unconditional`.
GiftVehicle	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the vehicle that's used to fulfill a gift commitment. Possible values are: `Bequest` `Charitable Gift Annuity` `Donor Advised Fund` `Life Insurance` `Other` `Pooled Income Fund` `Trust`
GiftVehicleType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of gift vehicle that fulfills the gift commitment. Possible values are: `Charitable Lead Trust` `Charitable Remainder Trust` `Deferred Gift Annuity` `Flexible Gift Annuity` `Immediate Gift Annuity` `Other`
IsAssetTransferExpected	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the donor intends to transfer non-monetary assets or not. The default value is `false`.
LastPaidTransactionDate	Type date Properties Filter, Group, Nillable, Sort Description The date of the last paid transaction for the commitment.
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 indirectly.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the gift commitment.
NextTransactionAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The expected amount of the next gift transaction in the commitment schedule. This is calculated automatically based on the currently active schedule.
NextTransactionDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date of the next gift transaction in the commitment schedule. This is calculated automatically based on the currently active schedule.
OpportunityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The opportunity associated with this commitment. This field is a relationship field. Relationship Name Opportunity Relationship Type Lookup Refers To Opportunity
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
RecurrenceType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of recurrence of a commitment. Possible values are: `Fixed Length` `Open Ended` The default value is `Open Ended`.
ScheduleType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the schedule and type of the commitment. Possible values are: `Custom` `Recurring` The default value is `Recurring`.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the commitment. Possible values are: `Active` `Closed` `Draft` `Failing` `Lapsed` `Paused` The default value is `Draft`.
TotCommitmentScheduleAmt	Type currency Properties Filter, Nillable, Sort Description The total expected donation amount that's calculated across all schedules in this commitment. This field is a calculated field.
TotExpcAssetMaturityVal	Type currency Properties Create, Filter, Nillable, Sort, Update Description The expected maturity value of all the committed assets for a commitment.
TotExpcAssetTransferVal	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total expected value of all the committed assets when they're transferred for a commitment.
TotalAssetPresentValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total current value of all the committed assets for a commitment.
TotalCurrentMonth	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total value of all gift commitments made for the current month. This field is available from API version 62.0 and later.
TotalCurrentQuarter	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total value of all gift commitments made for the current quarter. This field is available from API version 62.0 and later.
TotalCurrentYear	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total value of all gift commitments made for the current year. This field is available from API version 62.0 and later.
TotalNextYear	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total value of all gift commitments made for the next year. This field is available from API version 62.0 and later.
TotalPaidTransactionAmount	Type currency Properties Filter, Nillable, Sort Description The total amount of paid gift transactions for the commitment.
TransactionPaymentCount	Type int Properties Filter, Group, Nillable, Sort Description The number of paid gift transactions for the commitment.
WrittenOffAmount	Type currency Properties Filter, Nillable, Sort Description The total amount of written-off gift transactions for this commitment.

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.

GiftCommitmentChangeEvent (API Version 62.0): Change events are available for the object.
GiftCommitmentFeed: Feed tracking is available for the object.
GiftCommitmentHistory: History is available for tracked fields of the object.
GiftCommitmentShare: Sharing is available for the object.

Nonprofit Cloud Developer Guide

GiftCommitment

Supported Calls

Special Access Rules

Fields

Associated Objects