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

GiftBatch

Represents the details and status of the batch of gifts. 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
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the gift batch.
DoesTotalGiftValueMatch
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the total and estimated amount of gifts or total and estimated count of gifts in the gift batch match (true) or not (false).
The default value is false.
EstimatedGiftCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The expected number of gifts in the gift batch.
ExpectedValueofGiftsinBatch
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
When a single currency is accepted, this field shows the expected total value in the default currency of the gifts in the gift batch. When multiple currencies are accepted, this field is currency agnostic and is used to validate Estimated and Actual Batch values.
FailedGiftCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of gifts that failed to process.
LastProcessedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The last date and time when the gift batch was 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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The autogenerated name of the gift batch.
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
ProcessedGiftCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of gifts that have been processed.
ScreenTemplateName
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies the name of the screen template that's used for the gift batch.
Possible values are:
  • Default
The default value is Default.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the gift batch.
Possible values are:
  • Failed
  • In Progress
  • Partially Processed
  • Processed
  • Unprocessed
The default value is Unprocessed.
StatusReason
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reason for a gift batch status.
TotalBatchAmount
Type
double
Properties
Filter, Nillable, Sort
Description
When a single currency is accepted, this field shows the total value in the default currency of the gifts in the gift batch. When multiple currencies are accepted, this field is currency agnostic and is used to validate Estimated and Actual Batch values.
TotalGiftCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The total number of gifts in the gift batch.

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.

GiftBatchFeed
Feed tracking is available for the object.
GiftBatchHistory
History is available for tracked fields of the object.
GiftBatchShare
Sharing is available for the object.