Nonprofit Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Fundraising Standard Objects
DocGenerationQueryResult
DonorGiftConcept
DonorGiftSummary
GiftAgreement
GiftBatch
GiftCommitment
GiftCmtChangeAttrLog
GiftCommitmentSchedule
GiftDefaultDesignation
GiftDefaultSoftCredit
GiftDesignation
GiftEntry
GiftRefund
GiftSoftCredit
GiftTransaction
GiftTransactionDesignation
GiftTribute
GiftValueForecast
OutreachSourceCode
OutreachSummary
PartyCategory
PartyPhilanthropicAssessment
PartyPhilanthropicIndicator
PartyPhilanthropicMilestone
PartyPhilanthropicOccurrence
PartyPhilanthropicRsrchPrfl
PaymentInstrument
PlannedGift
PlannedGiftAnnuityRate
PlannedGiftPerformance
Fundraising Fields on Other Objects
Fundraising Business APIs
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

GiftTransaction

Represents a completed transaction from a gift. 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
AcknowledgementDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the gift transaction was acknowledged.
AcknowledgementStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the acknowledgement that's sent for the gift transaction.
Possible values are:
  • Don't Send
  • Sent
  • To Be Sent
The default value is To Be Sent.
CampaignId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The campaign associated with the gift transaction.
This field is a relationship field.
Relationship Name
Campaign
Relationship Type
Lookup
Refers To
Campaign
CheckDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on the check.
CurrentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The gift transaction amount after refunds.
This field is a calculated field.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Identifies the currency used for the gift transaction.
Valid value is:
  • USD—U.S. Dollar
The default value is USD. Available in API version 61.0 and later.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the gift transaction.
CurrentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
This field is a calculated field.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the gift transaction.
DonorCoverAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount the donor added to their gift to cover fees. Available in API version 61.0 and later.
DonorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The person, household, or organization account associated with the gift transaction.
This field is a relationship field.
Relationship Name
Donor
Relationship Type
Lookup
Refers To
Account
DonorGiftConceptId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift concept associated with the gift.
This field is a relationship field.
Relationship Name
DonorGiftConcept
Relationship Type
Lookup
Refers To
DonorGiftConcept
GatewayReference
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference of the transaction that the gateway assigned. This field is available from API version 60.0 and later.
GatewayTransactionFee
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The transaction fee charged by the payment gateway. This field is available from API version 60.0 and later.
GiftAgreementId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift agreement associated with the gift transaction.
This field is a relationship field.
Relationship Name
GiftAgreement
Relationship Type
Lookup
Refers To
GiftAgreement
GiftCommitmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift commitment associated with the gift transaction.
This field is a relationship field.
Relationship Name
GiftCommitment
Relationship Type
Lookup
Refers To
GiftCommitment
GiftCommitmentScheduleId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift commitment schedule associated with the gift transaction.
This field is a relationship field.
Relationship Name
GiftCommitmentSchedule
Relationship Type
Lookup
Refers To
GiftCommitmentSchedule
GiftType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of gift that's associated with the gift transaction.
Possible values are:
  • Individual
  • Organizational
The default value is Individual.
IsFullyRefunded
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Set to true when Status equals Fully Refunded. You can query and filter on this field, but you cannot directly set the value.
IsPaid
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Set to true when Status equals Paid and Current Amount equals 0. You can query and filter on this field, but you cannot directly set the value.
IsPartiallyRefunded
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Set to true when Status equals Paid and Current Amount is greater than 0. You can query and filter on this field, but you cannot directly set the value.
IsWrittenOff
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Set to true when Status equals Written-Off. You can query and filter on this field, but you cannot directly set the value.
LastGatewayErrorMessage
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The most recent error message that's received by the gateway. This field is available from API version 60.0 and later.
LastGatewayProcessedDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time of the last processing attempt by the gateway. This field is available from API version 60.0 and later.
LastGatewayResponseCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The most recent response code that's received by the gateway. This field is available from API version 60.0 and later.
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.
MatchingEmployerTransactionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift transaction made by the employer that matches the gift transaction.
This field is a relationship field.
Relationship Name
MatchingEmployerTransaction
Relationship Type
Lookup
Refers To
GiftTransaction
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the gift transaction.
NonTaxDeductibleAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The portion of the gift transaction amount that can't be claimed as a tax deduction by the donor. Available in API version 61.0 and later.
OriginalAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The original amount of gift transaction that includes donor cover and excludes the transaction fees. A value is always required in this field to save the record.
OutreachSourceCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The outreach source code associated with the gift transaction.
This field is a relationship field.
Relationship Name
OutreachSourceCode
Relationship Type
Lookup
Refers To
OutreachSourceCode
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
PartyPhilanthropicRsrchPrflId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The research profile associated with the gift.
This field is a relationship field.
Relationship Name
PartyPhilanthropicRsrchPrfl
Relationship Type
Lookup
Refers To
PartyPhilanthropicRsrchPrfl
PaymentIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number associated with the payment method for the gift, such as check number, transaction order number, merchant order number.
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, Sort, Update
Description
Specifies the payment method used to complete the gift transaction. A value is always required in this field to save the record.
Possible values are:
  • 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.
ProcessorTransactionFee
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The transaction fee charged by the payment processor. This field is available from API version 60.0 and later.
RefundedAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
The amount of the original gift transaction that was refunded.
This field is a calculated field.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies the status of the gift transaction. A value is always required in this field to save the record.
Possible values are:
  • Canceled
  • Failed
  • Fully Refunded
  • Paid
  • Pending
  • Unpaid
  • Written-Off
The default value is Unpaid.
TaxReceiptStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the tax receipt for the gift transaction. This field is available from API version 62.0 and later.
Possible values are:
  • Don't Send
  • Sent
  • To Be Sent
The default value is To Be Sent.
TotalTransactionFee
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of fees charged by the payment gateway and processor for this transaction. This field is available from API version 60.0 and later.
This field is a calculated field.
TransactionDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the donor completed the gift transaction.
This field is required if the gift transaction status is set to Paid or Fully Refunded.
TransactionDueDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The expected date of the scheduled gift transaction.
This field is required if the gift transaction is related to a gift 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.

GiftTransactionChangeEvent (API Version 62.0)
Change events are available for the object.
GiftTransactionFeed
Feed tracking is available for the object.
GiftTransactionHistory
History is available for tracked fields of the object.
GiftTransactionOwnerSharingRule
Sharing rules are available for the object.
GiftTransactionShare
Sharing is available for the object.