General Ledger
This API is used to manage the general ledger, including accounts, projects, and journal entries. This API has a maximum request size limit of 8mb.
GET
Period summary (List)
Once the summarization process is complete, this is the endpoint you use to get data returned.
Try itRequest URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| offset | integer | Represents the number of records to skip. For use with pagination. |
|
| limit | integer | Represents the number of records to return. The default is 100. The maximum allowed value is 5000. |
|
| fiscal_period_id | integer | The fiscal period identifier. |
|
| account_number | string | The account number. |
|
| ui_project_id | string | The project user-visible identifier. |
|
| fiscal_year_id | integer | The fiscal year. |
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. |
Response 200 OK
Returned when the operation is successful. The response body contains a list of summaries.
{
"count": 52548,
"value": [
{
"fiscal_year": "2011",
"fiscal_year_id": 12,
"fiscal_period": "8",
"fiscal_period_id": 133,
"period_start_date": "2008-01-01T00:00:00Z",
"period_end_date": "2008-01-31T00:00:00Z",
"account_number": "03-7000-00",
"ui_project_id": "1004",
"transaction_codes": [
{
"name": "Jurisdiction",
"value": "None",
"id": 0
},
{
"name": "Spendable?",
"value": "Spendable",
"id": 0
}
],
"beginning_balance": 0.0,
"debit": 14760.32,
"credit": 0.0,
"encumbered_beginning_balance": 0.0,
"encumbered_debit": 0.0,
"encumbered_credit": 0.0
},
{
"fiscal_year": "2011",
"fiscal_year_id": 12,
"fiscal_period": "8",
"fiscal_period_id": 133,
"period_start_date": "2008-01-01T00:00:00Z",
"period_end_date": "2008-01-31T00:00:00Z",
"account_number": "03-7000-00",
"ui_project_id": "1018",
"transaction_codes": [
{
"name": "Jurisdiction",
"value": "None",
"id": 0
},
{
"name": "Spendable?",
"value": "Spendable",
"id": 0
}
],
"beginning_balance": 0.0,
"debit": 6792.52,
"credit": 0.0,
"encumbered_beginning_balance": 0.0,
"encumbered_debit": 0.0,
"encumbered_credit": 0.0
}
]
}{
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer",
"x-ms-summary": "Count"
},
"value": {
"type": "array",
"items": {
"description": "Summarized record of GL activity for a particular period",
"type": "object",
"properties": {
"fiscal_year": {
"description": "The summarized fiscal year.",
"type": "string",
"x-ms-summary": "Fiscal year"
},
"fiscal_year_id": {
"format": "int32",
"description": "The summarized fiscal year database identifier.",
"type": "integer",
"x-ms-summary": "Fiscal year id"
},
"fiscal_period": {
"description": "The summarized fiscal period.",
"type": "string",
"x-ms-summary": "Fiscal period"
},
"fiscal_period_id": {
"format": "int32",
"description": "The summarized fiscal period database identifier.",
"type": "integer",
"x-ms-summary": "Fiscal period id"
},
"period_start_date": {
"format": "date-time",
"description": "The start date of the summarized period.",
"type": "string",
"x-ms-summary": "Period start date"
},
"period_end_date": {
"format": "date-time",
"description": "The end date of the summarized period.",
"type": "string",
"x-ms-summary": "Period end date"
},
"account_number": {
"description": "The account number of summarized transactions.",
"type": "string",
"x-ms-summary": "Account number"
},
"ui_project_id": {
"description": "The project identifier of summarized transactions.",
"type": "string",
"x-ms-summary": "Ui project id"
},
"transaction_codes": {
"description": "The transaction code values of summarized transactions.",
"type": "array",
"items": {
"description": "Transaction code value",
"required": [
"value",
"id"
],
"type": "object",
"properties": {
"name": {
"description": "The transaction code name.",
"type": "string",
"x-ms-summary": "Name"
},
"value": {
"description": "The transaction code value.",
"type": "string",
"x-ms-summary": "Value"
},
"id": {
"format": "int32",
"description": "The transaction code value id.",
"type": "integer",
"x-ms-summary": "Id"
},
"inactive": {
"description": "Indicate if record is inactive or not.",
"type": "boolean",
"x-ms-summary": "Inactive"
}
},
"x-display-name": "Transaction code value",
"x-ms-summary": "Transaction code value"
},
"x-ms-summary": "Transaction codes"
},
"beginning_balance": {
"format": "double",
"description": "The total transaction balance at the beginning of the summarized period.",
"type": "number",
"x-ms-summary": "Beginning balance"
},
"debit": {
"format": "double",
"description": "The sum of transaction debits int he summarized period.",
"type": "number",
"x-ms-summary": "Debit"
},
"credit": {
"format": "double",
"description": "The sum of transaction credits int he summarized period.",
"type": "number",
"x-ms-summary": "Credit"
},
"encumbered_beginning_balance": {
"format": "double",
"description": "The encumbered transaction balance at the beginning of the summarized period.",
"type": "number",
"x-ms-summary": "Encumbered beginning balance"
},
"encumbered_debit": {
"format": "double",
"description": "The sum of encumbered transaction debits int he summarized period.",
"type": "number",
"x-ms-summary": "Encumbered debit"
},
"encumbered_credit": {
"format": "double",
"description": "The sum of encumbered transaction credits int he summarized period.",
"type": "number",
"x-ms-summary": "Encumbered credit"
}
},
"x-display-name": "Ledger summary",
"x-ms-summary": "Ledger summary"
},
"x-ms-summary": "Value"
}
},
"x-hidden": true,
"x-display-name": "Api collection `1",
"x-ms-summary": "Api collection `1"
}Response 403 Forbidden
Returned when the user does not have permissions for funds or fiscal years.
{
"error": "The specified record could not be found. The record has either been deleted or you do not have rights to view it."
}{
"type": "object",
"properties": {
"Error": {
"type": "string",
"x-ms-summary": "Error"
}
},
"x-display-name": "Basic error message",
"x-ms-summary": "Basic error message"
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/generalledger/v1/periodsummary/summaries?offset={integer}&limit={integer}&fiscal_period_id={integer}&account_number={string}&ui_project_id={string}&fiscal_year_id={integer}"
-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}");
// Request parameters
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["fiscal_period_id"] = "{integer}";
queryString["account_number"] = "{string}";
queryString["ui_project_id"] = "{string}";
queryString["fiscal_year_id"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/generalledger/v1/periodsummary/summaries?" + 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/periodsummary/summaries");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("fiscal_period_id", "{integer}");
builder.setParameter("account_number", "{string}");
builder.setParameter("ui_project_id", "{string}");
builder.setParameter("fiscal_year_id", "{integer}");
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
"offset": "{integer}",
"limit": "{integer}",
"fiscal_period_id": "{integer}",
"account_number": "{string}",
"ui_project_id": "{string}",
"fiscal_year_id": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/generalledger/v1/periodsummary/summaries?" + $.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/periodsummary/summaries";
NSArray* array = @[
// Request parameters
@"entities=true",
@"offset={integer}",
@"limit={integer}",
@"fiscal_period_id={integer}",
@"account_number={string}",
@"ui_project_id={string}",
@"fiscal_year_id={integer}",
];
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/periodsummary/summaries');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'offset' => '{integer}',
'limit' => '{integer}',
'fiscal_period_id' => '{integer}',
'account_number' => '{string}',
'ui_project_id' => '{string}',
'fiscal_year_id' => '{integer}',
);
$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({
# Request parameters
'offset': '{integer}',
'limit': '{integer}',
'fiscal_period_id': '{integer}',
'account_number': '{string}',
'ui_project_id': '{string}',
'fiscal_year_id': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/periodsummary/summaries?%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({
# Request parameters
'offset': '{integer}',
'limit': '{integer}',
'fiscal_period_id': '{integer}',
'account_number': '{string}',
'ui_project_id': '{string}',
'fiscal_year_id': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/periodsummary/summaries?%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/summaries')
query = URI.encode_www_form({
# Request parameters
'offset' => '{integer}',
'limit' => '{integer}',
'fiscal_period_id' => '{integer}',
'account_number' => '{string}',
'ui_project_id' => '{string}',
'fiscal_year_id' => '{integer}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
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
Comments