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 |
|---|---|---|---|
| project_id | Property is required | integer | The identifier of the project to edit. |
Request headers
| Header | Required | Type | Description |
|---|---|---|---|
| Content-Type | string | Media type of the body sent to the API. | |
| 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. |
Request body
The changes to apply to the project.
{
"ui_project_id": "2200",
"description": "New Project",
"status": "Fundraising",
"type": "Administrative",
"start_date": "2018-05-18T00:00:00Z",
"end_date": "2018-12-18T00:00:00Z",
"prevent_data_entry": true,
"prevent_posting_after": true,
"posting_date": "2018-05-18T00:00:00Z",
"location": "Campus",
"division": "Division",
"department": "01 - Administration",
"account_restrictions": {
"allow_or_restrict": "Restrict",
"criteria": "Selected",
"selected_account_numbers": [
"01-1000-00"
]
},
"custom_fields": [
{
"field_name": "Endowment Manager",
"value": "Jack Stephens",
"comments": "new comment",
"date": "2018-05-18T00:00:00Z"
}
]
}{
"description": "Edit project",
"type": "object",
"properties": {
"description": {
"description": "The project description.",
"type": "string",
"x-ms-summary": "Description"
},
"ui_project_id": {
"description": "The project user-visible identifier.",
"type": "string",
"x-ms-summary": "Ui project id"
},
"start_date": {
"format": "date-time",
"description": "The project start date, in ISO 8601 format: 2016-03-14.",
"type": "string",
"x-ms-summary": "Start date"
},
"end_date": {
"format": "date-time",
"description": "The project end date, in ISO 8601 format: 2016-03-14.",
"type": "string",
"x-ms-summary": "End date"
},
"location": {
"description": "The project location.",
"type": "string",
"x-ms-summary": "Location"
},
"division": {
"description": "The project division.",
"type": "string",
"x-ms-summary": "Division"
},
"department": {
"description": "The project department.",
"type": "string",
"x-ms-summary": "Department"
},
"type": {
"description": "The project type.",
"type": "string",
"x-ms-summary": "Type"
},
"status": {
"description": "The project status.",
"type": "string",
"x-ms-summary": "Status"
},
"prevent_data_entry": {
"description": "If to prevent data entry for this project.",
"type": "boolean",
"x-ms-summary": "Prevent data entry"
},
"prevent_posting_after": {
"description": "If preventing data entry, if to prevent posting after a certain date.",
"type": "boolean",
"x-ms-summary": "Prevent posting after"
},
"posting_date": {
"format": "date-time",
"description": "The date after which to prevent posting, if applicable.",
"type": "string",
"x-ms-summary": "Posting date"
},
"custom_fields": {
"description": "The custom fields for this project.",
"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"
},
"account_restrictions": {
"description": "The account allowances or restrictions for this project.",
"type": "object",
"properties": {
"allow_or_restrict": {
"description": "Indicates if the criteria is allowed or restricted.",
"enum": [
"Allow",
"Restrict"
],
"type": "string",
"x-ms-summary": "Allow or restrict"
},
"criteria": {
"description": "The criteria for the allowance or restriction.",
"enum": [
"All",
"Selected",
"Range",
"Query"
],
"type": "string",
"x-ms-summary": "Criteria"
},
"selected_account_numbers": {
"description": "The selected account numbers for the project account restrictions.\r\nRequired when `criteria` is `Selected`",
"type": "array",
"items": {
"type": "string"
},
"x-ms-summary": "Selected account numbers"
},
"account_range_from_account_number": {
"description": "The beginning account number for an account range for project account restrictions.\r\nRequired when `criteria` is `Range`",
"type": "string",
"x-ms-summary": "Account range from account number"
},
"account_range_to_account_number": {
"description": "The beginning account number for an account range for project account restrictions.\r\nRequired when `criteria` is `Range`",
"type": "string",
"x-ms-summary": "Account range to account number"
}
},
"x-hidden": true,
"x-display-name": "Create project account restrictions",
"x-ms-summary": "Account restrictions"
}
},
"example": {
"ui_project_id": "2200",
"description": "New Project",
"status": "Fundraising",
"type": "Administrative",
"start_date": "2018-05-18T00:00:00Z",
"end_date": "2018-12-18T00:00:00Z",
"prevent_data_entry": true,
"prevent_posting_after": true,
"posting_date": "2018-05-18T00:00:00Z",
"location": "Campus",
"division": "Division",
"department": "01 - Administration",
"account_restrictions": {
"allow_or_restrict": "Restrict",
"criteria": "Selected",
"selected_account_numbers": [
"01-1000-00"
]
},
"custom_fields": [
{
"field_name": "Endowment Manager",
"value": "Jack Stephens",
"comments": "new comment",
"date": "2018-05-18T00:00:00Z"
}
]
},
"x-hidden": true,
"x-display-name": "Edit project",
"x-ms-summary": "Edit project"
}Response 200 OK
Returned when the operation successfully edits the project. The response body contains the project id.
{
"record_id": 0
}{
"type": "object",
"properties": {
"record_id": {
"format": "int32",
"type": "integer",
"x-ms-summary": "Record id"
}
},
"x-hidden": true,
"x-display-name": "Created result `1",
"x-ms-summary": "Created result `1"
}Response 400 Bad Request
Returned when the request is not in the correct format or are invalid.
{
"Error": "Failed to save {record}",
"Details": [
"The total percent distributed must equal 100%."
],
"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 edit projects.
{
"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 project 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 PATCH "https://api.sky.blackbaud.com/generalledger/v1/projects/{project_id}"
-H "Content-Type: application/json"
-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/projects/{project_id}?" + queryString;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
var request = new HttpRequestMessage(new HttpMethod("PATCH"), uri);
request.Content = content;
var response = await client.SendAsync(request);
}
}
}
}// // 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/projects/{project_id}");
URI uri = builder.build();
HttpPatch request = new HttpPatch(uri);
request.setHeader("Content-Type", "application/json");
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/projects/{project_id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
type: "PATCH",
// 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/projects/{project_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:@"PATCH"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/projects/{project_id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'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_PATCH);
// 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
'Content-Type': 'application/json',
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("PATCH", "/generalledger/v1/projects/{project_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
'Content-Type': 'application/json',
'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("PATCH", "/generalledger/v1/projects/{project_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/projects/{project_id}')
request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
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