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.
Transaction distribution (List)
Returns a list of transactions matching the search criteria
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. |
|
account_number | string | The account number. |
|
ui_project_id | string | The project user-visible identifier. |
|
batch_id | integer | The database batch identifier. |
|
ui_batch_id | integer | The user-visible batch identifier. |
|
journal | string | The full name of the journal. |
|
from_date | string | The minimum post date to include records. |
|
to_date | string | The maximum post date to include records. |
|
type_code | string | The journal entry transaction type (debit or credit). |
|
transaction_code_1_value | string | The transaction code 1 value. |
|
transaction_code_2_value | string | The transaction code 2 value. |
|
transaction_code_3_value | string | The transaction code 3 value. |
|
transaction_code_4_value | string | The transaction code 4 value. |
|
transaction_code_5_value | string | The transaction code 5 value. |
|
last_modified | string | Returns modified records based on or after a specified date. |
|
encumbrance | string | The encumbrance of the transaction distribution. |
|
post_status | string | The post status of the transaction distribution. |
|
include_tax_entity | boolean | Include tax entity information. |
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 list transaction distributions.
{
"count": 379362,
"value": [
{
"transaction_id": 5348,
"transaction_amount": 333.33,
"distribution_id": 13861,
"batch_id": 50,
"ui_batch_id": 240,
"distribution_amount": 30.0,
"account_number": "01-5450-02",
"account_class": "Unrestricted Net Assets",
"ui_project_id": "1001",
"post_date": "2005-01-10T00:00:00Z",
"type_code": "Debit",
"reference": "AlphaGraphics-6363636-003",
"journal": "Accounts Payable",
"encumbrance": "Regular",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "Youth Services",
"id": 0
},
{
"name": "Spendable?",
"value": "Spendable",
"id": 0
}
],
"date_added": "2004-11-10T16:44:50.53Z",
"added_by": "Supervisor",
"date_modified": "2004-11-11T09:16:10.123Z",
"modified_by": "Supervisor",
"post_status": "Posted",
"tax_entity_name": "GST"
},
{
"transaction_id": 5348,
"transaction_amount": 333.33,
"distribution_id": 13862,
"batch_id": 50,
"ui_batch_id": 240,
"distribution_amount": 30.0,
"account_number": "01-5450-02",
"account_class": "Temporarily Restricted Net Assets",
"ui_project_id": "1002",
"post_date": "2005-01-10T00:00:00Z",
"type_code": "Debit",
"reference": "AlphaGraphics-6363636-003",
"journal": "Accounts Payable",
"encumbrance": "Regular",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "Emergency Relief",
"id": 0
},
{
"name": "Spendable?",
"value": "Non-Spendable",
"id": 0
}
],
"date_added": "2004-11-10T16:44:50.53Z",
"added_by": "Supervisor",
"date_modified": "2004-11-11T09:16:10.123Z",
"modified_by": "Supervisor",
"post_status": "Posted"
}
]
}
{
"type": "object",
"properties": {
"count": {
"format": "int32",
"type": "integer",
"x-ms-summary": "Count"
},
"value": {
"type": "array",
"items": {
"description": "Transaction Distribution.",
"required": [
"transaction_code_values"
],
"type": "object",
"properties": {
"transaction_id": {
"format": "int32",
"description": "The transaction identifier.",
"type": "integer",
"x-ms-summary": "Transaction id"
},
"transaction_amount": {
"format": "double",
"description": "The transaction amount.",
"type": "number",
"x-ms-summary": "Transaction amount"
},
"distribution_id": {
"format": "int32",
"description": "The distribution identifier.",
"type": "integer",
"x-ms-summary": "Distribution id"
},
"batch_id": {
"format": "int32",
"description": "The database batch identifier",
"type": "integer",
"x-ms-summary": "Batch id"
},
"ui_batch_id": {
"format": "int32",
"description": "The user-visible batch identifier",
"type": "integer",
"x-ms-summary": "Ui batch id"
},
"distribution_amount": {
"format": "double",
"description": "The distribution amount.",
"type": "number",
"x-ms-summary": "Distribution amount"
},
"account_number": {
"description": "The account number.",
"type": "string",
"x-ms-summary": "Account number"
},
"account_class": {
"description": "The account class.",
"type": "string",
"x-ms-summary": "Account class"
},
"ui_project_id": {
"description": "The project user-visible identifier.",
"type": "string",
"x-ms-summary": "Ui project id"
},
"post_date": {
"format": "date-time",
"description": "The transaction post date.",
"type": "string",
"x-ms-summary": "Post date"
},
"type_code": {
"description": "The transaction type (debit or credit).",
"enum": [
"Debit",
"Credit"
],
"type": "string",
"x-ms-summary": "Type code"
},
"reference": {
"description": "The transaction reference.",
"type": "string",
"x-ms-summary": "Reference"
},
"journal": {
"description": "The full name of the journal.",
"type": "string",
"x-ms-summary": "Journal"
},
"encumbrance": {
"description": "The transaction encumbrance type.",
"type": "string",
"x-ms-summary": "Encumbrance"
},
"transaction_code_values": {
"description": "The distribution transaction codes.",
"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"
},
"date_added": {
"format": "date-time",
"description": "The created date of the transaction distribution.",
"type": "string",
"x-ms-summary": "Date added"
},
"added_by": {
"description": "The creator of the transaction distribution.",
"type": "string",
"x-ms-summary": "Added by"
},
"date_modified": {
"format": "date-time",
"description": "The modified date of the transaction distribution.",
"type": "string",
"x-ms-summary": "Date modified"
},
"modified_by": {
"description": "The modifier of the transaction distribution.",
"type": "string",
"x-ms-summary": "Modified by"
},
"post_status": {
"description": "The post status of the transaction distribution.",
"enum": [
"Posted",
"NotYetPosted"
],
"type": "string",
"x-ms-summary": "Post status"
},
"tax_entity_name": {
"description": "The tax entity name of the transaction distribution.",
"type": "string",
"x-ms-summary": "Tax entity name"
}
},
"x-display-name": "Transaction distribution",
"x-ms-summary": "Transaction distribution"
},
"x-ms-summary": "Value"
}
},
"x-hidden": true,
"x-display-name": "Api collection `1",
"x-ms-summary": "Api collection `1"
}
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",
"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 entries.
{
"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/transactiondistributions?offset={integer}&limit={integer}&account_number={string}&ui_project_id={string}&batch_id={integer}&ui_batch_id={integer}&journal={string}&from_date={string}&to_date={string}&type_code={string}&transaction_code_1_value={string}&transaction_code_2_value={string}&transaction_code_3_value={string}&transaction_code_4_value={string}&transaction_code_5_value={string}&last_modified={string}&encumbrance={string}&post_status={string}&include_tax_entity={boolean}"
-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["account_number"] = "{string}";
queryString["ui_project_id"] = "{string}";
queryString["batch_id"] = "{integer}";
queryString["ui_batch_id"] = "{integer}";
queryString["journal"] = "{string}";
queryString["from_date"] = "{string}";
queryString["to_date"] = "{string}";
queryString["type_code"] = "{string}";
queryString["transaction_code_1_value"] = "{string}";
queryString["transaction_code_2_value"] = "{string}";
queryString["transaction_code_3_value"] = "{string}";
queryString["transaction_code_4_value"] = "{string}";
queryString["transaction_code_5_value"] = "{string}";
queryString["last_modified"] = "{string}";
queryString["encumbrance"] = "{string}";
queryString["post_status"] = "{string}";
queryString["include_tax_entity"] = "{boolean}";
var uri = "https://api.sky.blackbaud.com/generalledger/v1/transactiondistributions?" + 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/transactiondistributions");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("account_number", "{string}");
builder.setParameter("ui_project_id", "{string}");
builder.setParameter("batch_id", "{integer}");
builder.setParameter("ui_batch_id", "{integer}");
builder.setParameter("journal", "{string}");
builder.setParameter("from_date", "{string}");
builder.setParameter("to_date", "{string}");
builder.setParameter("type_code", "{string}");
builder.setParameter("transaction_code_1_value", "{string}");
builder.setParameter("transaction_code_2_value", "{string}");
builder.setParameter("transaction_code_3_value", "{string}");
builder.setParameter("transaction_code_4_value", "{string}");
builder.setParameter("transaction_code_5_value", "{string}");
builder.setParameter("last_modified", "{string}");
builder.setParameter("encumbrance", "{string}");
builder.setParameter("post_status", "{string}");
builder.setParameter("include_tax_entity", "{boolean}");
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}",
"account_number": "{string}",
"ui_project_id": "{string}",
"batch_id": "{integer}",
"ui_batch_id": "{integer}",
"journal": "{string}",
"from_date": "{string}",
"to_date": "{string}",
"type_code": "{string}",
"transaction_code_1_value": "{string}",
"transaction_code_2_value": "{string}",
"transaction_code_3_value": "{string}",
"transaction_code_4_value": "{string}",
"transaction_code_5_value": "{string}",
"last_modified": "{string}",
"encumbrance": "{string}",
"post_status": "{string}",
"include_tax_entity": "{boolean}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/generalledger/v1/transactiondistributions?" + $.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/transactiondistributions";
NSArray* array = @[
// Request parameters
@"entities=true",
@"offset={integer}",
@"limit={integer}",
@"account_number={string}",
@"ui_project_id={string}",
@"batch_id={integer}",
@"ui_batch_id={integer}",
@"journal={string}",
@"from_date={string}",
@"to_date={string}",
@"type_code={string}",
@"transaction_code_1_value={string}",
@"transaction_code_2_value={string}",
@"transaction_code_3_value={string}",
@"transaction_code_4_value={string}",
@"transaction_code_5_value={string}",
@"last_modified={string}",
@"encumbrance={string}",
@"post_status={string}",
@"include_tax_entity={boolean}",
];
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/transactiondistributions');
$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}',
'account_number' => '{string}',
'ui_project_id' => '{string}',
'batch_id' => '{integer}',
'ui_batch_id' => '{integer}',
'journal' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'type_code' => '{string}',
'transaction_code_1_value' => '{string}',
'transaction_code_2_value' => '{string}',
'transaction_code_3_value' => '{string}',
'transaction_code_4_value' => '{string}',
'transaction_code_5_value' => '{string}',
'last_modified' => '{string}',
'encumbrance' => '{string}',
'post_status' => '{string}',
'include_tax_entity' => '{boolean}',
);
$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}',
'account_number': '{string}',
'ui_project_id': '{string}',
'batch_id': '{integer}',
'ui_batch_id': '{integer}',
'journal': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'type_code': '{string}',
'transaction_code_1_value': '{string}',
'transaction_code_2_value': '{string}',
'transaction_code_3_value': '{string}',
'transaction_code_4_value': '{string}',
'transaction_code_5_value': '{string}',
'last_modified': '{string}',
'encumbrance': '{string}',
'post_status': '{string}',
'include_tax_entity': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/transactiondistributions?%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}',
'account_number': '{string}',
'ui_project_id': '{string}',
'batch_id': '{integer}',
'ui_batch_id': '{integer}',
'journal': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'type_code': '{string}',
'transaction_code_1_value': '{string}',
'transaction_code_2_value': '{string}',
'transaction_code_3_value': '{string}',
'transaction_code_4_value': '{string}',
'transaction_code_5_value': '{string}',
'last_modified': '{string}',
'encumbrance': '{string}',
'post_status': '{string}',
'include_tax_entity': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/generalledger/v1/transactiondistributions?%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/transactiondistributions')
query = URI.encode_www_form({
# Request parameters
'offset' => '{integer}',
'limit' => '{integer}',
'account_number' => '{string}',
'ui_project_id' => '{string}',
'batch_id' => '{integer}',
'ui_batch_id' => '{integer}',
'journal' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'type_code' => '{string}',
'transaction_code_1_value' => '{string}',
'transaction_code_2_value' => '{string}',
'transaction_code_3_value' => '{string}',
'transaction_code_4_value' => '{string}',
'transaction_code_5_value' => '{string}',
'last_modified' => '{string}',
'encumbrance' => '{string}',
'post_status' => '{string}',
'include_tax_entity' => '{boolean}'
})
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