General Ledger

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

GET

Journal entry batch summary

Returns the journal entry batch summary.

Try it

Request URL

Request parameters

Parameter Required Type Description
batch_id Property is required integer

The journal entry batch identifier.

Request headers

Header Required Type Description
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.

Response 200 OK

Returned when the operation is successful. The response body contains the journal entry batch details.

{
  "BatchId": 0,
  "UiBatchId": "string",
  "Description": "string",
  "BatchStatus": "Open",
  "CreateInterfundSets": true,
  "CreateBankAccountAdjustments": true,
  "DateAdded": "string",
  "AddedBy": "string",
  "DateModified": "string",
  "ModifiedBy": "string"
}
{
  "required": [
    "Description",
    "BatchStatus"
  ],
  "type": "object",
  "properties": {
    "BatchId": {
      "format": "int32",
      "description": "The batch identifier.",
      "type": "integer"
    },
    "UiBatchId": {
      "description": "The batch user-visible identifier.",
      "type": "string"
    },
    "Description": {
      "description": "The batch description.",
      "type": "string"
    },
    "BatchStatus": {
      "description": "The batch status.",
      "enum": [
        "Open",
        "PendingApproval",
        "Approved",
        "Posted",
        "Deleted"
      ],
      "type": "string"
    },
    "CreateInterfundSets": {
      "description": "Indicates if or not the batch should create interfund entries when posted.",
      "type": "boolean"
    },
    "CreateBankAccountAdjustments": {
      "description": "Indicates if or not the batch should create bank account admustments when posted.",
      "type": "boolean"
    },
    "DateAdded": {
      "format": "date-time",
      "description": "The created date of the batch.",
      "type": "string"
    },
    "AddedBy": {
      "description": "The creator of the batch.",
      "type": "string"
    },
    "DateModified": {
      "format": "date-time",
      "description": "The modified date of the batch.",
      "type": "string"
    },
    "ModifiedBy": {
      "description": "The modifier of the batch.",
      "type": "string"
    }
  },
  "x-display-name": "Journal entry batch summary"
}

Response 400 Bad Request

Returned when the request is not in the correct format.

{
  "Error": "string",
  "Details": [
    "string"
  ],
  "ErrorPath": "string"
}
{
  "type": "object",
  "properties": {
    "Error": {
      "type": "string"
    },
    "Details": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "ErrorPath": {
      "type": "string"
    }
  },
  "x-display-name": "Domain error message"
}

Response 403 Forbidden

Returned when the user does not have permission to view journal entry batches.

{
  "Error": "string"
}
{
  "type": "object",
  "properties": {
    "Error": {
      "type": "string"
    }
  },
  "x-display-name": "Basic error message"
}

Response 404 Not Found

Returned when the specified journal entry batch could not be found.

{
  "Error": "string"
}
{
  "type": "object",
  "properties": {
    "Error": {
      "type": "string"
    }
  },
  "x-display-name": "Basic error message"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/generalledger/v1/journalentrybatches/{batch_id}/summary"
-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", "{access token}");

            var uri = "https://api.sky.blackbaud.com/generalledger/v1/journalentrybatches/{batch_id}/summary?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}
// // 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/journalentrybatches/{batch_id}/summary");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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/journalentrybatches/{batch_id}/summary?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "GET",
            // 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/journalentrybatches/{batch_id}/summary";
    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:@"GET"];
    // Request headers
    [_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/journalentrybatches/{batch_id}/summary');
$url = $request->getUrl();

$headers = array(
    // Request headers
   '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_GET);

// 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
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/generalledger/v1/journalentrybatches/{batch_id}/summary?%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
    '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("GET", "/generalledger/v1/journalentrybatches/{batch_id}/summary?%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/journalentrybatches/{batch_id}/summary')

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

# Request headers
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