Process Gift Entries Action

Processes, singly or as part of a batch, a specified gift entry ID, creating related donor, gift transaction, gift transaction designation, and gift soft credit records. You may also test gift entry processing to check for errors before creating related records.

This action is available in API version 59.0 and later for users in orgs where the Fundraising Access license is enabled and the Fundraising User system permission is assigned.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/processGiftEntries
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
giftEntryId
Type
ID
Description
Required.
The ID of the gift entry record to be processed.
isDryRun
Type
Boolean
Description
Indicates whether to run the action without creating or updating records to determine if there are any errors (true) or actual processing (false).

The default value is false.

Outputs

Output Details
donorId
Type
ID
Description
The ID of the person, household, or organization account that’s associated with the gift entry.
giftEntryId
Type
ID
Description
The ID of the gift entry record that is processed.
giftProcessingErrorDetails
Type
String
Description
The error details when the gift processing status is Failure.
giftProcessingStatus
Type
String
Description
The processing status of the gift entry.

Valid values are:

  • Failure
  • New
  • Success
giftTransactionId
Type
ID
Description
The ID of the gift transaction that’s associated with the gift entry.

Example

Here’s a request for the Process Gift Entries action for processing a gift entry.

{
  "inputs": [
    {
      "giftEntryId": "6geRM00000000GdYAI"
    }
  ]
}

Here’s a response for the Process Gift Entries action for processing a gift entry.

[
  {
    "actionName": "processGiftEntries",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "giftProcessingStatus": "SUCCESS",
      "giftEntryId": "6geRM00000000GdYAI",
      "giftTransactionId": "6trRM00000003PJ",
      "giftProcessingErrorDetails": null,
      "donorId": "001RM000005ewDDYAY"
    },
    "version": 1
  }
]

Here’s a request for the Process Gift Entries action for a dry run of gift entry processing.

{
  "inputs": [
    {
      "giftEntryId": "6geRM00000000GdYAI",
      "isDryRun": "true",
    }
  ]
}

Here’s a response for the Process Gift Entries action for a dry run of gift entry processing.

[
  {
    "actionName": "processGiftEntries",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "giftProcessingStatus": "New",
      "giftEntryId": "6geRM00000000GdYAI",
      "giftTransactionId": null,
      "giftProcessingErrorDetails": null,
      "donorId": null
    },
    "version": 1
  }
]