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

Project

Returns the specified project.

Try it

Request URL

Request parameters

Parameter Required Type Description
project_id Property is required integer

The identifier for the project to retrieve.

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 specificed project.

{
  "project_id": 1,
  "description": "Rogers Endowment",
  "ui_project_id": "1008",
  "start_date": "1999-10-01T00:00:00Z",
  "end_date": null,
  "location": "",
  "division": "",
  "department": "",
  "type": "Endowment",
  "status": "In Progress",
  "prevent_data_entry": false,
  "prevent_posting_after": false,
  "posting_date": "2018-07-06T04:00:00Z",
  "account_restrictions": {
    "allow_or_restrict": "Allow",
    "criteria": "Query",
    "query": "All active accounts"
  },
  "contacts": [
    {
      "contact_id": 1,
      "description": "",
      "country": "",
      "city": "Chicago",
      "county": "",
      "state": "IL",
      "address_line": "154 Oakdale Drive",
      "postal": "87635",
      "title": "Mr",
      "first_name": "John",
      "middle_name": "",
      "last_name": "Rogers",
      "suffix": "Sr",
      "position": "",
      "address_contact_methods": [
        {
          "contact_method_id": 1,
          "contact_type": "Business",
          "contact_info": "(876) 987-6354"
        }
      ]
    }
  ],
  "custom_fields": [],
  "date_added": "2002-01-08T00:00:00Z",
  "date_modified": "2002-02-18T04:59:11Z",
  "added_by": "Supervisor",
  "modified_by": "Data Entry"
}
{
  "description": "General ledger project detail",
  "type": "object",
  "properties": {
    "project_id": {
      "format": "int32",
      "description": "The project database identifier.",
      "type": "integer",
      "x-ms-summary": "Project id"
    },
    "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"
    },
    "account_restrictions": {
      "description": "The account allowances or restrictions for this project.",
      "type": "object",
      "properties": {
        "allow_or_restrict": {
          "description": "Allow or restrict account usage for this project.",
          "enum": [
            "Allow",
            "Restrict"
          ],
          "type": "string",
          "x-ms-summary": "Allow or restrict"
        },
        "criteria": {
          "description": "Criteria to define the specific accounts.",
          "enum": [
            "All",
            "Selected",
            "Range",
            "Query"
          ],
          "type": "string",
          "x-ms-summary": "Criteria"
        },
        "selected_accounts": {
          "description": "The selected accounts for the project account restrictions.",
          "type": "array",
          "items": {
            "description": "Account restriction summary class",
            "type": "object",
            "properties": {
              "account_number": {
                "description": "The number for the account.",
                "type": "string",
                "x-ms-summary": "Account number"
              },
              "account_id": {
                "format": "int32",
                "description": "The identifier for the account",
                "type": "integer",
                "x-ms-summary": "Account id"
              }
            },
            "x-hidden": true,
            "x-display-name": "Account restriction summary",
            "x-ms-summary": "Account restriction summary"
          },
          "x-ms-summary": "Selected accounts"
        },
        "account_range_from_account": {
          "description": "The beginning account for an account range for project account restrictions.\r\nRequired when `criteria` is `Range`",
          "type": "object",
          "properties": {
            "account_number": {
              "description": "The number for the account.",
              "type": "string",
              "x-ms-summary": "Account number"
            },
            "account_id": {
              "format": "int32",
              "description": "The identifier for the account",
              "type": "integer",
              "x-ms-summary": "Account id"
            }
          },
          "x-hidden": true,
          "x-display-name": "Account restriction summary",
          "x-ms-summary": "Account range from account"
        },
        "account_range_to_account": {
          "description": "The beginning account for an account range for project account restrictions.\r\nRequired when `criteria` is `Range`",
          "type": "object",
          "properties": {
            "account_number": {
              "description": "The number for the account.",
              "type": "string",
              "x-ms-summary": "Account number"
            },
            "account_id": {
              "format": "int32",
              "description": "The identifier for the account",
              "type": "integer",
              "x-ms-summary": "Account id"
            }
          },
          "x-hidden": true,
          "x-display-name": "Account restriction summary",
          "x-ms-summary": "Account range to account"
        },
        "query": {
          "description": "The name of the query for the project account restrictions.",
          "type": "string",
          "x-ms-summary": "Query"
        }
      },
      "x-display-name": "Project account restrictions detail",
      "x-ms-summary": "Account restrictions"
    },
    "contacts": {
      "description": "The contacts for this project.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contact_id": {
            "format": "int32",
            "description": "The identifier for this contact.",
            "type": "integer",
            "x-ms-summary": "Contact id"
          },
          "description": {
            "description": "The description for this address.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "country": {
            "description": "The country for the address.",
            "type": "string",
            "x-ms-summary": "Country"
          },
          "city": {
            "description": "The city for the address.",
            "type": "string",
            "x-ms-summary": "City"
          },
          "county": {
            "description": "The county for this address.",
            "type": "string",
            "x-ms-summary": "County"
          },
          "state": {
            "description": "The state or province (or suburb in NZ) for the address.",
            "type": "string",
            "x-ms-summary": "State"
          },
          "address_line": {
            "description": "The street information / address line for this address.",
            "type": "string",
            "x-ms-summary": "Address line"
          },
          "postal": {
            "description": "Refers to the Postal Code or ZIP of the address.",
            "type": "string",
            "x-ms-summary": "Postal"
          },
          "title": {
            "description": "The title for the primary contact.",
            "type": "string",
            "x-ms-summary": "Title"
          },
          "first_name": {
            "description": "The first name of the primary contact.",
            "type": "string",
            "x-ms-summary": "First name"
          },
          "middle_name": {
            "description": "The middle initial or name of the primary contact.",
            "type": "string",
            "x-ms-summary": "Middle name"
          },
          "last_name": {
            "description": "The last name of the primary contact.",
            "type": "string",
            "x-ms-summary": "Last name"
          },
          "suffix": {
            "description": "The suffix of the primary contact.",
            "type": "string",
            "x-ms-summary": "Suffix"
          },
          "position": {
            "description": "The position of the primary contact.",
            "type": "string",
            "x-ms-summary": "Position"
          },
          "address_contact_methods": {
            "description": "The list of contact methods for this address.",
            "type": "array",
            "items": {
              "description": "Address information",
              "required": [
                "contact_type",
                "contact_info"
              ],
              "type": "object",
              "properties": {
                "contact_method_id": {
                  "format": "int32",
                  "description": "The address contact method identifier.",
                  "type": "integer",
                  "x-ms-summary": "Contact method id"
                },
                "contact_type": {
                  "description": "The type of contact (email, phone, etc).",
                  "type": "string",
                  "x-ms-summary": "Contact type"
                },
                "contact_info": {
                  "description": "The contact information (email address, phone number, etc) for this method.",
                  "type": "string",
                  "x-ms-summary": "Contact info"
                }
              },
              "x-display-name": "Address contact method",
              "x-ms-summary": "Address contact method"
            },
            "x-ms-summary": "Address contact methods"
          }
        },
        "x-display-name": "Contact address",
        "x-ms-summary": "Contact address"
      },
      "x-ms-summary": "Contacts"
    },
    "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"
    },
    "date_added": {
      "format": "date-time",
      "description": "The created date of the project.",
      "type": "string",
      "x-ms-summary": "Date added"
    },
    "date_modified": {
      "format": "date-time",
      "description": "The modified date of the project.",
      "type": "string",
      "x-ms-summary": "Date modified"
    },
    "added_by": {
      "description": "The creator of the project.",
      "type": "string",
      "x-ms-summary": "Added by"
    },
    "modified_by": {
      "description": "The modifier of the project.",
      "type": "string",
      "x-ms-summary": "Modified by"
    }
  },
  "x-display-name": "Project detail",
  "x-ms-summary": "Project detail"
}

Response 403 Forbidden

Returned when the user does not have permission to view 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 the specified project 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/projects/{project_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/projects/{project_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/projects/{project_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/projects/{project_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/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:@"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/projects/{project_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/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
    '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/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::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

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!