Education 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 Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
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
PDF

GiftEntry

Represents gifts created individually or in a batch before they're processed and logged in their target records. After processing, these records serve as an audit trail for gift transactions. 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 that's associated with the gift entry.
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 that is used as the payment method for the gift.
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city where the donor resides.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country where the donor resides.
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.
DonorCoverAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The fee amount that a donor pays in addition to the gift amount.
DonorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The person, household, or organization account associated with the gift.
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. Available in API version 61.0 and later.
Email
Type
email
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The email of the donor.
ExpectedEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the total amount of the commitment is expected to be paid. Available in API version 61.0 and later.
ExpiryMonth
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The month of the credit card expiration date. This field is available from API version 60.0 and later.
ExpiryYear
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The year of the credit card expiration date. This field is available from API version 60.0 and later.
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The first name of the donor.
GiftAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The amount of the gift.
GiftBatchId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The parent gift batch that's associated with the gift entry.
This field is a relationship field.
Relationship Name
GiftBatch
Relationship Type
Lookup
Refers To
GiftBatch
GiftCommitmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift commitment that's associated with the gift entry.
This field is a relationship field.
Relationship Name
GiftCommitment
Relationship Type
Lookup
Refers To
GiftCommitment
GiftDesignation1Amount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount to be allocated to designation 1.
GiftDesignation1Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the designation 1 to which the gift amount is to be allocated.
This field is a relationship field.
Relationship Name
GiftDesignation1
Relationship Type
Lookup
Refers To
GiftDesignation
GiftDesignation1Percent
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage of gift amount to be allocated to designation 1 if the direct amount isn’t being allocated.
GiftDesignation2Amount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount to be allocated to designation 2.
GiftDesignation2Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the designation 2 to which the gift amount is to be allocated.
This field is a relationship field.
Relationship Name
GiftDesignation2
Relationship Type
Lookup
Refers To
GiftDesignation
GiftDesignation2Percent
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage of gift amount to be allocated to designation 2 if the direct amount isn’t being allocated.
GiftDesignation3Amount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount to be allocated to designation 3.
GiftDesignation3Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the designation 3 to which the gift amount is to be allocated.
This field is a relationship field.
Relationship Name
GiftDesignation3
Relationship Type
Lookup
Refers To
GiftDesignation
GiftDesignation3Percent
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage of gift amount to be allocated to designation 3 if the direct amount isn’t being allocated.
GiftProcessingResult
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The processing result of the gift entry record.
GiftProcessingStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the processing status of the gift entry.
Possible values are:
  • Failure
  • New
  • Success
The default value is New.
GiftReceivedDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date when the gift is received.
GiftTransactionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gift transaction that's associated with the gift entry.
This field is a relationship field.
Relationship Name
GiftTransaction
Relationship Type
Lookup
Refers To
GiftTransaction
GiftType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the type of gift that's associated with the gift entry.
Possible values are:
  • Individual
  • Organizational
The default value is Individual.
HomePhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The home phone number of the donor.
IsNewRecurringGift
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the gift is a new recurring gift commitment (true) or not (false).
The default value is false. Available in API version 61.0 and later.
IsSetAsDefault
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the values in the gift entry are used as default values in other gift entries of the gift batch or not.
The default value is false.
Last4
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last 4 digits of the credit card or bank account. This field is available from API version 60.0 and later.
LastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last name of the donor.
LastProcessedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the gift entry was last processed.
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.
MobilePhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The mobile number of the donor.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the gift entry record.
OrganizationName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the donating organization that's associated with the gift entry.
OutreachSourceCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The outreach source code that's associated with the campaign for the gift entry record.
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. ID of the creator of this object.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PaymentIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier of the payment method for the gift, such as check number, transaction order number, merchant order number.
PaymentMethod
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Specifies the payment method used for this gift.
Possible values are:
  • ACH
  • Asset
  • Cash
  • Check
  • Credit Card
  • Cryptocurrency
  • In-Kind
  • PayPal
  • Stock
  • Unknown
  • Venmo
PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code from the donor's address.
Salutation
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the honorific abbreviation, word, or phrase to be used in front of the donor's name in greetings, such as Dr. or Mrs.
Possible values are:
  • Dr.
  • Mr.
  • Mrs.
  • Ms.
  • Mx.
  • Prof.
SoftCreditInformation
Type
textarea
Properties
Create, Nillable, Update
Description
The information about the soft credit, such as the name of the soft creditor, role, and amount or percentage of soft credit allocated to the soft creditor.
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the state or province where the donor resides.
Street
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street details from the donor's address.
TotalTransactionFeeAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The total transaction fees charged by the payment processor for the gift. For example, application fees, processing fees.
TransactionDay
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the day of the month to create gift transaction in the future for a monthly 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.
Valid values are: numerals 1–30 and LastDay (of the month)
The default value is 1. Available in API version 61.0 and later.
TransactionInterval
Type
int
Properties
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 transaction interval is 3, the schedule is run after every three months. Available in API version 61.0 and later.
TransactionPeriod
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, 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 transaction frequency is 3, the schedule is run after every three months.
Valid values are:
  • Custom
  • Daily
  • Monthly
  • Weekly
  • Yearly
The default value is Monthly. Available in API version 61.0 and later.