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	Type	Description
giftEntryId	ID	Required. The ID of the gift entry record to be processed.
isDryRun	Boolean	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	Type	Description
donorId	ID	The ID of the person, household, or organization account that's associated with the gift entry.
giftEntryId	ID	The ID of the gift entry record that is processed.
giftProcessingErrorDetails	String	The error details when the gift processing status is `Failure`.
giftProcessingStatus	String	The processing status of the gift entry. Valid values are `Failure`, `New`, or `Success`.
giftTransactionId	ID	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.

1{
2  "inputs": [
3    {
4      "giftEntryId": "6geRM00000000GdYAI"
5    }
6  ]
7}

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

1[
2  {
3    "actionName": "processGiftEntries",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "giftProcessingStatus": "SUCCESS",
8      "giftEntryId": "6geRM00000000GdYAI",
9      "giftTransactionId": "6trRM00000003PJ",
10      "giftProcessingErrorDetails": null,
11      "donorId": "001RM000005ewDDYAY"
12    },
13    "version": 1
14  }
15]

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

1{
2  "inputs": [
3    {
4      "giftEntryId": "6geRM00000000GdYAI",
5      "isDryRun": "true",
6    }
7  ]
8}

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

1[
2  {
3    "actionName": "processGiftEntries",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "giftProcessingStatus": "New",
8      "giftEntryId": "6geRM00000000GdYAI",
9      "giftTransactionId": null,
10      "giftProcessingErrorDetails": null,
11      "donorId": null
12    },
13    "version": 1
14  }
15]

Nonprofit Cloud Developer Guide

Process Gift Entries Action

Supported REST HTTP Methods

Inputs

Outputs

Example