Gift (Beta)

This API manages gift information and related entities such as gift splits, gift fundraisers, and soft credits.

POST

Gift

Creates a gift. At this time, you can only post gifts with the "Donation" gift_type and the "Cash", "CreditCard", "PersonalCheck", "DirectDebit", or "Other" payment_method.

Try it

Request URL

Request headers

Content-Type string Media type of the body sent to the API.
bb-api-subscription-key Property is required string Subscription key which provides access to this API. Found in your Profile.
Authorization Property is required string OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code, Implicit.

Request body

An object that represents the gift to create.

lookup_idstringThe user-defined identifier for the gift. Character limit: 50.
datedateTimeThe gift date. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43
amountProperty is requiredcurrencyThe monetary amount of the gift.
typeProperty is requiredstringThe gift type. Available values are listed here.
constituent_idProperty is requiredstringThe immutable system record ID of the constituent associated with the gift.
is_anonymousbooleanIndicates whether the gift is anonymous.
gift_splitsProperty is requiredarray of gift splitThe set of gift splits associated with the gift.
subtypestringThe subtype of the gift. Available values are the entries in the Gift Subtypes table.
soft_creditsarray of soft creditThe set of soft credits associated with the gift.
fundraisersarray of fundraiserThe set of fundraisers who receive credit for the gift.
post_statusstringThe general ledger post status of the gift. Available values are Posted, NotPosted, and DoNotPost. When post_status is set to DoNotPost, then post_date should be null. When it is set to NotPosted, then post_date is editable. When it is set to Posted, then post_date must be set and is no longer editable.
post_datedateTimeThe date that the gift was posted to general ledger. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43.
gift_statusstringThe status of the gift. Available values are Active, Held, Terminated, Completed, and Cancelled.
referencestringNotes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind. Character limit: 255.
paymentsProperty is requiredarray of paymentThe payments on the gift.

{
  "lookup_id": 2225,
  "date": "2017-10-03T00:00:00",
  "amount": {
    "value": 100
  },
  "type": "Donation",
  "constituent_id": 280,
  "is_anonymous": false,
  "gift_splits": [
    {
      "fund_id": "41",
      "campaign_id": "1",
      "appeal_id": "15",
      "amount": {
        "value": 100
      }
    }
  ],
  "subtype": "Annuity",
  "soft_credits": [
    {
      "constituent_id": 187,
      "amount": {
        "value": 100
      }
    }
  ],
  "fundraisers": [
    {
      "constituent_id": 252,
      "amount": {
        "value": 100
      }
    }
  ],
  "post_status": "NotPosted",
  "post_date": "2017-10-03T00:00:00",
  "gift_status": "Active",
  "reference": "newly added gift",
  "payments": [
    {
      "payment_method": "Cash"
    }
  ]
}
{
  "description": "Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.",
  "required": [
    "amount",
    "type",
    "constituent_id",
    "gift_splits",
    "payments"
  ],
  "type": "object",
  "properties": {
    "lookup_id": {
      "description": "The user-defined identifier for the gift. Character limit: 50.",
      "type": "string"
    },
    "date": {
      "format": "date-time",
      "description": "The gift date. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string",
      "x-supports-datetime-offset": false
    },
    "amount": {
      "description": "The monetary amount of the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "type": {
      "description": "The gift type. Available values <a href=\"#GiftTypes\">are listed below</a>.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The immutable system record ID of the constituent associated with the gift.",
      "type": "string"
    },
    "is_anonymous": {
      "description": "Indicates whether the gift is anonymous.",
      "type": "boolean"
    },
    "gift_splits": {
      "description": "The set of gift splits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Not all gifts serve a single purpose. Gift splits track donor wishes and allow you to divide gifts among multiple campaigns, funds, and appeals.",
        "required": [
          "fund_id",
          "amount"
        ],
        "type": "object",
        "properties": {
          "fund_id": {
            "description": "The immutable system record ID of the fund associated with the gift split.",
            "type": "string"
          },
          "amount": {
            "description": "The amount of the gift split",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "campaign_id": {
            "description": "The immutable system record ID of the campaign associated with the gift split.",
            "type": "string"
          },
          "appeal_id": {
            "description": "The immutable system record ID of the appeal associated with the gift split.",
            "type": "string"
          },
          "package_id": {
            "description": "The immutable system record ID of the package associated with the gift split.",
            "type": "string"
          }
        },
        "x-hidden": true
      }
    },
    "subtype": {
      "description": "The subtype of the gift. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/598a0dd6d7dcde047cb504ce\"><b>Gift Subtypes</b></a> table.",
      "type": "string"
    },
    "soft_credits": {
      "description": "The set of soft credits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Soft credits allow you to recognize and track the indirect contributions of constituents such as spouses who influence the gifts of other constituents.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount of the soft credit.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the soft credit.",
            "type": "string"
          }
        },
        "x-hidden": true
      }
    },
    "fundraisers": {
      "description": "The set of fundraisers who receive credit for the gift.",
      "type": "array",
      "items": {
        "description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and request donations. When a constituent makes a donation, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount credited to the fundraiser for the gift.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable constituent system record ID for the fundraiser associated with the gift.",
            "type": "string"
          }
        },
        "x-hidden": true
      }
    },
    "post_status": {
      "description": "The general ledger post status of the gift. Available values are <i>Posted</i>, <i>NotPosted</i>, and <i>DoNotPost.</i> When <code>post_status</code> is set to <i>DoNotPost</i>, then <code>post_date</code> should be null. When it is set to <i>NotPosted</i>, then <code>post_date</code> is editable. When it is set to <i>Posted</i>, then <code>post_date</code> must be set and is no longer editable.",
      "type": "string"
    },
    "post_date": {
      "format": "date-time",
      "description": "The date that the gift was posted to general ledger. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string",
      "x-supports-datetime-offset": false
    },
    "gift_status": {
      "description": "The status of the gift. Available values are <i>Active</i>, <i>Held</i>, <i>Terminated</i>, <i>Completed</i>, and <i>Cancelled.</i>",
      "type": "string"
    },
    "reference": {
      "description": "Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind. Character limit: 255.",
      "type": "string"
    },
    "payments": {
      "description": "The payments on the gift.",
      "type": "array",
      "items": {
        "description": "Donors can use a variety of methods — such as Cash, Personal check, Credit card, and Direct debit — to pay for gifts.",
        "required": [
          "payment_method"
        ],
        "type": "object",
        "properties": {
          "payment_method": {
            "description": "The payment method. Available values <a href=\"#PaymentMethods\">are listed below</a>.",
            "type": "string"
          }
        },
        "x-hidden": true
      }
    }
  },
  "example": {
    "lookup_id": 2225,
    "date": "2017-10-03T00:00:00",
    "amount": {
      "value": 100
    },
    "type": "Donation",
    "constituent_id": 280,
    "is_anonymous": false,
    "gift_splits": [
      {
        "fund_id": "41",
        "campaign_id": "1",
        "appeal_id": "15",
        "amount": {
          "value": 100
        }
      }
    ],
    "subtype": "Annuity",
    "soft_credits": [
      {
        "constituent_id": 187,
        "amount": {
          "value": 100
        }
      }
    ],
    "fundraisers": [
      {
        "constituent_id": 252,
        "amount": {
          "value": 100
        }
      }
    ],
    "post_status": "NotPosted",
    "post_date": "2017-10-03T00:00:00",
    "gift_status": "Active",
    "reference": "newly added gift",
    "payments": [
      {
        "payment_method": "Cash"
      }
    ]
  },
  "x-hidden": true
}

Response 200

Returned when the operation successfully creates a gift. The response body contains the ID of the new gift.

{
  "id": "1281"
}
{
  "description": "Defines the shape of a post response object.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The newly created Id",
      "type": "string"
    }
  },
  "x-hidden": true
}

Response 400

Returned when the specified request body is not in the appropriate format.

Response 403

Returned when the user does not have permission to create the gift.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/gift/v1/gifts"
-H "Content-Type: application/json"
-H "bb-api-subscription-key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }

        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("bb-api-subscription-key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");

            var uri = "https://api.sky.blackbaud.com/gift/v1/gifts?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample
{
    public static void main(String[] args)
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/gift/v1/gifts");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
           request.setHeader("Content-Type", "application/json");
           request.setHeader("bb-api-subscription-key", "{subscription key}");
           request.setHeader("Authorization", "Bearer {access token}");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null)
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}
<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/gift/v1/gifts?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
               xhrObj.setRequestHeader("Content-Type","application/json");
               xhrObj.setRequestHeader("bb-api-subscription-key","{subscription key}");
               xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"https://api.sky.blackbaud.com/gift/v1/gifts";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"bb-api-subscription-key"];
    [_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);

        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }

        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }

        NSLog(@"%@", json);
        _connectionData = nil;
    }

    [pool drain];

    return 0;
}
<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.sky.blackbaud.com/gift/v1/gifts');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Content-Type' => 'application/json',
   'bb-api-subscription-key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'bb-api-subscription-key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/gift/v1/gifts?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'bb-api-subscription-key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/gift/v1/gifts?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.sky.blackbaud.com/gift/v1/gifts')

request = Net::HTTP::Post.new(uri.request_uri)

# Request headers
request['Content-Type'] = 'application/json'
request['bb-api-subscription-key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'

# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body