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
Journal entry batch
Returns the journal entry batch details.
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. |
Response 200 OK
Returned when the operation is successful. The response body contains the journal entry batch details.
{
"batch_id": 2223,
"ui_batch_id": "1617",
"description": "SmartTuition - Cash - 05/18/2018",
"batch_status": "Posted",
"create_interfund_sets": true,
"create_bank_account_adjustments": true,
"journal_entries": [
{
"journal_entry_id": 319113,
"type_code": "Debit",
"line_number": 1,
"account_number": "01-1000-00",
"post_date": "2018-05-18T00:00:00Z",
"encumbrance": "Regular",
"journal": "eTapestry",
"reference": "SmartTuition - Late Fee Withheld Inschool",
"amount": 1.0,
"tax_entity_id": 427,
"tax_entity_name": "GST",
"notes": "",
"distributions": [
{
"distribution_id": 414692,
"ui_project_id": "1009",
"account_class": "Unrestricted Net Assets",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "",
"id": 1
},
{
"name": "Spendable?",
"value": "",
"id": 2
},
{
"name": "RE Appeals",
"value": "",
"id": 3
},
{
"name": "Grant",
"value": "",
"id": 4
},
{
"name": "Activities",
"value": "",
"id": 5
}
],
"amount": 1.0,
"percent": 100.0
}
],
"custom_fields": [],
"reverse_date": "2018-08-02T00:00:00Z",
"reverse_transaction_id": 0
},
{
"journal_entry_id": 319114,
"type_code": "Credit",
"line_number": 2,
"account_number": "01-1210-00",
"post_date": "2018-05-18T00:00:00Z",
"encumbrance": "Regular",
"journal": "eTapestry",
"reference": "SmartTuition - Late Fee Withheld Inschool",
"amount": 1.0,
"tax_entity_id": 427,
"tax_entity_name": "GST",
"notes": "",
"distributions": [
{
"distribution_id": 414693,
"ui_project_id": "1009",
"account_class": "Unrestricted Net Assets",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "",
"id": 1
},
{
"name": "Spendable?",
"value": "",
"id": 2
},
{
"name": "RE Appeals",
"value": "",
"id": 3
},
{
"name": "Grant",
"value": "",
"id": 4
},
{
"name": "Activities",
"value": "",
"id": 5
}
],
"amount": 1.0,
"percent": 100.0
}
],
"custom_fields": [],
"reverse_date": null,
"reverse_transaction_id": 786508
}
],
"date_added": "2018-07-03T14:24:03.493Z",
"added_by": "James Bradley",
"date_modified": "2018-07-03T14:24:03.73Z",
"modified_by": "James Bradley"
}{
"description": "Journal Entry Batch.",
"required": [
"description",
"batch_status"
],
"type": "object",
"properties": {
"batch_id": {
"format": "int32",
"description": "The batch identifier.",
"type": "integer",
"x-ms-summary": "Batch id"
},
"ui_batch_id": {
"description": "The batch user-visible identifier.",
"type": "string",
"x-ms-summary": "Ui batch id"
},
"description": {
"description": "The batch description.",
"type": "string",
"x-ms-summary": "Description"
},
"batch_status": {
"description": "The batch status.",
"enum": [
"Open",
"PendingApproval",
"Approved",
"Posted",
"Deleted"
],
"type": "string",
"x-ms-summary": "Batch status"
},
"create_interfund_sets": {
"description": "Indicates if or not the batch should create interfund entries when posted.",
"type": "boolean",
"x-ms-summary": "Create interfund sets"
},
"create_bank_account_adjustments": {
"description": "Indicates if or not the batch should create bank account adjustments when posted.",
"type": "boolean",
"x-ms-summary": "Create bank account adjustments"
},
"source_base_url": {
"description": "Base url for batch source system.",
"type": "string",
"x-ms-summary": "Source base url"
},
"source_system_name": {
"description": "Name of source system that created the batch.",
"type": "string",
"x-ms-summary": "Source system name"
},
"journal_entries": {
"description": "The set of journal entries for the batch.",
"type": "array",
"items": {
"description": "Journal entry.",
"required": [
"type_code",
"account_number",
"post_date",
"encumbrance",
"journal",
"reference",
"amount",
"distributions"
],
"type": "object",
"properties": {
"journal_entry_id": {
"format": "int32",
"description": "The journal entry identifier.",
"type": "integer",
"x-ms-summary": "Journal entry id"
},
"type_code": {
"description": "The journal entry transaction type (debit or credit).",
"enum": [
"Debit",
"Credit"
],
"type": "string",
"x-ms-summary": "Type code"
},
"tax_entity_id": {
"format": "int32",
"description": "The journal entry tax entity Id.",
"type": "integer",
"x-ms-summary": "Tax entity id"
},
"tax_entity_name": {
"description": "The journal entry tax entity name.",
"type": "string",
"x-ms-summary": "Tax entity name"
},
"line_number": {
"format": "int32",
"description": "The journal entry line number.",
"type": "integer",
"x-ms-summary": "Line number"
},
"account_number": {
"description": "The journal entry account number.",
"type": "string",
"x-ms-summary": "Account number"
},
"post_date": {
"format": "date-time",
"description": "The journal entry post date, in ISO 8601 format: 2016-03-14.",
"type": "string",
"x-ms-summary": "Post date"
},
"encumbrance": {
"description": "The journal entry encumbrance type.",
"enum": [
"Regular",
"Encumbrance"
],
"type": "string",
"x-ms-summary": "Encumbrance"
},
"journal": {
"description": "The full name of the journal.",
"type": "string",
"x-ms-summary": "Journal"
},
"reference": {
"description": "The journal entry reference.",
"type": "string",
"x-ms-summary": "Reference"
},
"amount": {
"format": "double",
"description": "The journal entry amount.",
"type": "number",
"x-ms-summary": "Amount"
},
"notes": {
"description": "The journal entry notes.",
"type": "string",
"x-ms-summary": "Notes"
},
"relative_source_url": {
"description": "Relative URL for the journal entry that appends to the batch source_base_url.",
"type": "string",
"x-ms-summary": "Relative source url"
},
"distributions": {
"description": "The journal entry distributions.",
"type": "array",
"items": {
"description": "Journal Entry Distribution.",
"required": [
"transaction_code_values"
],
"type": "object",
"properties": {
"distribution_id": {
"format": "int32",
"description": "The distribution identifier.",
"type": "integer",
"x-ms-summary": "Distribution id"
},
"ui_project_id": {
"description": "The user-visible identifier of the project.",
"type": "string",
"x-ms-summary": "Ui project id"
},
"account_class": {
"description": "The class for this distribution.",
"type": "string",
"x-ms-summary": "Account class"
},
"transaction_code_values": {
"description": "The distribution transaction code values. The values should be in the same order as the codes defined in the database.",
"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 code values"
},
"amount": {
"format": "double",
"description": "The distribution amount.",
"type": "number",
"x-ms-summary": "Amount"
},
"percent": {
"format": "double",
"description": "The distribution journal entry amount percentage.",
"type": "number",
"x-ms-summary": "Percent"
}
},
"x-display-name": "Distribution",
"x-ms-summary": "Distribution"
},
"x-ms-summary": "Distributions"
},
"custom_fields": {
"description": "The journal entry custom fields.",
"type": "array",
"items": {
"description": "Custom field definition.",
"type": "object",
"properties": {
"custom_field_id": {
"format": "int32",
"description": "The identifier for this custom field.",
"type": "integer",
"x-ms-summary": "Custom field id"
},
"field_name": {
"description": "The name of the custom field.",
"type": "string",
"x-ms-summary": "Field name"
},
"value": {
"description": "The value for this custom field.",
"type": "string",
"x-ms-summary": "Value"
},
"comments": {
"description": "The description for this custom field.",
"type": "string",
"x-ms-summary": "Comments"
},
"type": {
"description": "The type of this custom field.",
"enum": [
"Text",
"Number",
"DateTime",
"Currency",
"Boolean",
"Table",
"FuzzyDate"
],
"type": "string",
"x-ms-summary": "Type"
},
"date": {
"format": "date-time",
"description": "The date on this custom field.",
"type": "string",
"x-ms-summary": "Date"
}
},
"x-display-name": "Custom field",
"x-ms-summary": "Custom field"
},
"x-ms-summary": "Custom fields"
},
"reverse_date": {
"format": "date-time",
"description": "The journal entry reverse date.",
"type": "string",
"x-ms-summary": "Reverse date"
},
"reverse_transaction_id": {
"format": "int32",
"description": "The transaction id of the reversed journal entry.",
"type": "integer",
"x-ms-summary": "Reverse transaction id"
}
},
"example": {
"type_code": "Debit",
"account_number": "01-1000-00",
"post_date": "2018-07-02T00:00:00Z",
"encumbrance": "Regular",
"journal": "Journal Entry",
"reference": "Debit reference",
"amount": 10.0,
"notes": "New Note",
"distributions": [
{
"ui_project_id": "1100",
"account_class": "Unrestricted Net Assets",
"transaction_code_values": [
{
"name": "Grants",
"value": "None",
"id": 1
},
{
"name": "Spendable?",
"value": "Spendable",
"id": 2
}
],
"amount": 5.0,
"percent": 50.0
},
{
"ui_project_id": "1200",
"account_class": "Unrestricted Net Assets",
"transaction_code_values": [
{
"name": "Grants",
"value": "None",
"id": 1
},
{
"name": "Spendable?",
"value": "Non spendable",
"id": 2
}
],
"amount": 5.0,
"percent": 50.0
}
],
"custom_fields": [
{
"field_name": "Unique Auth Text",
"value": "My text",
"comments": "a comment",
"date": "2018-07-02T00:00:00Z"
}
],
"reverse_date": "2018-07-03T00:00:00Z"
},
"x-display-name": "Journal entry",
"x-ms-summary": "Journal entry"
},
"x-ms-summary": "Journal entries"
},
"date_added": {
"format": "date-time",
"description": "The created date of the batch.",
"type": "string",
"x-ms-summary": "Date added"
},
"added_by": {
"description": "The creator of the batch.",
"type": "string",
"x-ms-summary": "Added by"
},
"date_modified": {
"format": "date-time",
"description": "The modified date of the batch.",
"type": "string",
"x-ms-summary": "Date modified"
},
"modified_by": {
"description": "The modifier of the batch.",
"type": "string",
"x-ms-summary": "Modified by"
}
},
"x-display-name": "Journal entry batch",
"x-ms-summary": "Journal entry batch"
}Response 400 Bad Request
Returned when the request is not in the correct format.
{
"Error": "Invalid Request",
"Details": [
"The value 'fake' is not valid for transaction_status."
],
"ErrorPath": null
}{
"type": "object",
"properties": {
"Error": {
"type": "string",
"x-ms-summary": "Error"
},
"Details": {
"type": "array",
"items": {
"type": "string"
},
"x-ms-summary": "Details"
},
"ErrorPath": {
"type": "string",
"x-ms-summary": "Error path"
}
},
"x-display-name": "Domain error message",
"x-ms-summary": "Domain error message"
}Response 403 Forbidden
Returned when the user does not have permission to view journal entry batches.
{
"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 the specified journal entry batch could not be found.
{
"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/journalentrybatches/{batch_id}"
-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/journalentrybatches/{batch_id}?" + 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}");
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}?" + $.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}";
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}');
$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}?%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}?%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}')
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