General Ledger

This API is used to manage the general ledger, including accounts, projects, and journal entries.

POST

Period summary process (Start)

Starts the period summary process.

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

{
  "fiscal_period_id": 0
}
{
  "required": [
    "fiscal_period_id"
  ],
  "type": "object",
  "properties": {
    "fiscal_period_id": {
      "format": "int32",
      "description": "The fiscal period for the summary process.",
      "type": "integer"
    }
  },
  "x-display-name": "Start summarize process"
}

Response 200

Returned when the operation is successful. The response body contains the summary processing info.

{
  "status": "string",
  "status_message": "string",
  "process_id": "00000000-0000-0000-0000-000000000000",
  "fiscal_period_id": 0
}
{
  "description": "Summary process info",
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "status_message": {
      "type": "string"
    },
    "process_id": {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "fiscal_period_id": {
      "format": "int32",
      "type": "integer"
    }
  },
  "x-display-name": "Summary process info"
}

Response 400

Returned when an invalid fiscal period id is provided.

Response 403

Returned when the user does not have permissions for funds or fiscal years.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/generalledger/v1/periodSummary/summarize"
-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/generalledger/v1/periodSummary/summarize?" + 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/generalledger/v1/periodSummary/summarize");


            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/generalledger/v1/periodSummary/summarize?" + $.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/generalledger/v1/periodSummary/summarize";
    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/generalledger/v1/periodSummary/summarize');
$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", "/generalledger/v1/periodSummary/summarize?%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", "/generalledger/v1/periodSummary/summarize?%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/generalledger/v1/periodSummary/summarize')

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