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.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| scenario_id | Property is required | integer | The identifier for the budget scenario. |
| scenarioId | integer | Format - int32. |
|
| 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. |
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 collection of budget lines for the specified budget scenario.
{
"count": 32,
"value": [
{
"account_number": "31-405000",
"account_description": "Tuition",
"budget_line_id": 1,
"ui_project_id": "CC001",
"project_description": "CC at USC - General Operating",
"grant_description": null,
"notes": "This is a note",
"total": 1079479,
"periods": [
{
"amount": 0,
"sequence": 1,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 2,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 3,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 4,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 5,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 6,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 7,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 8,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 9,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 10,
"year_id": "2005-2006 FY"
},
{
"amount": 134935,
"sequence": 11,
"year_id": "2005-2006 FY"
},
{
"amount": 134934,
"sequence": 12,
"year_id": "2005-2006 FY"
}
]
},
{
"account_number": "31-410000",
"account_description": "Gifts",
"budget_line_id": 2,
"ui_project_id": "CC001",
"project_description": "CC at USC - General Operating",
"grant_description": null,
"notes": "This is another note",
"total": 50000,
"periods": [
{
"amount": 0,
"sequence": 1,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 2,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 3,
"year_id": "2005-2006 FY"
},
{
"amount": 0,
"sequence": 4,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 5,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 6,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 7,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 8,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 9,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 10,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 11,
"year_id": "2005-2006 FY"
},
{
"amount": 6250,
"sequence": 12,
"year_id": "2005-2006 FY"
}
]
}
]
}{
"description": "Budget line",
"required": [
"account_number",
"account_description",
"total",
"periods"
],
"type": "object",
"properties": {
"account_number": {
"description": "The number for an account on this budget.",
"type": "string",
"x-ms-summary": "Account number"
},
"account_description": {
"description": "The description for an account on this budget.",
"type": "string",
"x-ms-summary": "Account description"
},
"budget_line_id": {
"format": "int32",
"type": "integer",
"x-ms-summary": "Budget line id"
},
"ui_project_id": {
"description": "The user defined project id for this budget line.",
"type": "string",
"x-ms-summary": "Ui project id"
},
"project_description": {
"description": "The description for a project on this budget line.",
"type": "string",
"x-ms-summary": "Project description"
},
"grant_description": {
"description": "The description of the {Grant} t-code.",
"type": "string",
"x-ms-summary": "Grant description"
},
"total": {
"format": "double",
"description": "The total amount for this budget line.",
"type": "number",
"x-ms-summary": "Total"
},
"periods": {
"description": "The period distributions for this budget line.",
"type": "array",
"items": {
"description": "Budget period info",
"required": [
"amount",
"sequence",
"year_id"
],
"type": "object",
"properties": {
"amount": {
"format": "double",
"description": "The amount for this period.",
"type": "number",
"x-ms-summary": "Amount"
},
"sequence": {
"format": "int32",
"description": "The sequence number of the fiscal year of this period.",
"type": "integer",
"x-ms-summary": "Sequence"
},
"year_id": {
"description": "The fiscal year of this period.",
"type": "string",
"x-ms-summary": "Year id"
}
},
"x-display-name": "Budget period info",
"x-ms-summary": "Budget period info"
},
"x-ms-summary": "Periods"
},
"notes": {
"description": "The note for this budget line.",
"type": "string",
"x-ms-summary": "Notes"
}
},
"x-display-name": "Budget line",
"x-ms-summary": "Budget line"
}Response 403 Forbidden
Returned when the user does not have permission to view budgets.
{
"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"
}Response 404 Not Found
Returned when no budget is found with the specified ID.
{
"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/budgets/{scenario_id}/details/lines?scenarioId={integer}&offset={integer}&limit={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["scenarioId"] = "{integer}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/generalledger/v1/budgets/{scenario_id}/details/lines?" + 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/budgets/{scenario_id}/details/lines");
builder.setParameter("scenarioId", "{integer}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{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
"scenarioId": "{integer}",
"offset": "{integer}",
"limit": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/generalledger/v1/budgets/{scenario_id}/details/lines?" + $.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/budgets/{scenario_id}/details/lines";
NSArray* array = @[
// Request parameters
@"entities=true",
@"scenarioId={integer}",
@"offset={integer}",
@"limit={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/budgets/{scenario_id}/details/lines');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'scenarioId' => '{integer}',
'offset' => '{integer}',
'limit' => '{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
'scenarioId': '{integer}',
'offset': '{integer}',
'limit': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/budgets/{scenario_id}/details/lines?%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
'scenarioId': '{integer}',
'offset': '{integer}',
'limit': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/budgets/{scenario_id}/details/lines?%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/budgets/{scenario_id}/details/lines')
query = URI.encode_www_form({
# Request parameters
'scenarioId' => '{integer}',
'offset' => '{integer}',
'limit' => '{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