General Ledger

This API is used to manage the general ledger, including accounts, projects, and journal entries.

GET Account

Retrieves information about a given account.

Try it

Request URL

Request parameters

account_id Property is required integer

The identifier for the account to retrieve.

Request headers

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, Implicit.

Response 200

Returned when the operation is successful. The response body contains the specified account.

{
  "account_id": 0,
  "account_number": "string",
  "description": "string",
  "prevent_data_entry": true,
  "prevent_posting_date": "string",
  "class": "string",
  "cashflow": "string",
  "working_capital": "string",
  "custom_fields": [
    {
      "custom_field_id": 0,
      "field_name": "string",
      "value": "string",
      "comments": "string",
      "type": "Text",
      "date": "string"
    }
  ],
  "default_transaction_codes": [
    {
      "name": "string",
      "value": "string",
      "id": 0
    }
  ],
  "date_added": "string",
  "added_by": "string",
  "date_modified": "string",
  "modified_by": "string"
}
{
  "description": "AccountDetail class.",
  "type": "object",
  "properties": {
    "account_id": {
      "format": "int32",
      "description": "The identifier for this account.",
      "type": "integer"
    },
    "account_number": {
      "description": "The account number for this account.",
      "type": "string"
    },
    "description": {
      "description": "The description for this account.",
      "type": "string"
    },
    "prevent_data_entry": {
      "description": "If to prevent data entry.\r\nIf a date is given for prevent posting, this value is set to true.",
      "type": "boolean"
    },
    "prevent_posting_date": {
      "format": "date-time",
      "description": "If, and the date after which, to prevent posting.\r\nFilling out this field will automatically set the prevent data entry field to 'true'.",
      "type": "string"
    },
    "class": {
      "description": "The class for this account.",
      "type": "string"
    },
    "cashflow": {
      "description": "The cash flow for this account.",
      "type": "string"
    },
    "working_capital": {
      "description": "The working capital schedule for this account.",
      "type": "string"
    },
    "custom_fields": {
      "description": "The custom fields on this account.",
      "type": "array",
      "items": {
        "description": "Custom field definition.",
        "type": "object",
        "properties": {
          "custom_field_id": {
            "format": "int32",
            "description": "The identifier for this custom field.",
            "type": "integer"
          },
          "field_name": {
            "description": "The name of the custom field.",
            "type": "string"
          },
          "value": {
            "description": "The value for this custom field.",
            "type": "string"
          },
          "comments": {
            "description": "The description for this custom field.",
            "type": "string"
          },
          "type": {
            "description": "The type of this custom field.",
            "enum": [
              "Text",
              "Number",
              "DateTime",
              "Currency",
              "Boolean",
              "Table",
              "FuzzyDate"
            ],
            "type": "string"
          },
          "date": {
            "format": "date-time",
            "description": "The date on this custom field.",
            "type": "string"
          }
        },
        "x-display-name": "Custom field"
      }
    },
    "default_transaction_codes": {
      "description": "The default transaction codes on this account.",
      "type": "array",
      "items": {
        "description": "Transaction code value",
        "required": [
          "value",
          "id"
        ],
        "type": "object",
        "properties": {
          "name": {
            "description": "The transaction code name.",
            "type": "string"
          },
          "value": {
            "description": "The transaction code value.",
            "type": "string"
          },
          "id": {
            "format": "int32",
            "description": "The transaction code value id.",
            "type": "integer"
          }
        },
        "x-display-name": "Transaction code value"
      }
    },
    "date_added": {
      "format": "date-time",
      "description": "The created date of the account.",
      "type": "string"
    },
    "added_by": {
      "description": "The creator of the account.",
      "type": "string"
    },
    "date_modified": {
      "format": "date-time",
      "description": "The modified date of the account.",
      "type": "string"
    },
    "modified_by": {
      "description": "The modifier of the account.",
      "type": "string"
    }
  },
  "x-display-name": "Account detail"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.sky.blackbaud.com/generalledger/v1/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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/accounts/{account_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