General Ledger

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

GET

Transaction distribution (List)

Returns a list of transactions matching the search criteria

Try it

Request 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 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

The last modified date

encumbrance string

The encumbrance of the transaction distribution.

post_status string

The post status of the transaction distribution.

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

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,
      "distribution_amount": 30.0,
      "account_number": "01-5450-02",
      "account_class": "Unrestricted Net Assets",
      "ui_project_id": "1001",
      "post_date": "2005-01-10T00:00:00",
      "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.53",
      "added_by": "Supervisor",
      "date_modified": "2004-11-11T09:16:10.123",
      "modified_by": "Supervisor",
      "post_status": "Posted"
    },
    {
      "transaction_id": 5348,
      "transaction_amount": 333.33,
      "distribution_id": 13862,
      "batch_id": 50,
      "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:00",
      "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.53",
      "added_by": "Supervisor",
      "date_modified": "2004-11-11T09:16:10.123",
      "modified_by": "Supervisor",
      "post_status": "Posted"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "type": "integer"
    },
    "value": {
      "type": "array",
      "items": {
        "description": "Transaction Distribution.",
        "required": [
          "transaction_code_values"
        ],
        "type": "object",
        "properties": {
          "transaction_id": {
            "format": "int32",
            "description": "The transaction identifier.",
            "type": "integer"
          },
          "transaction_amount": {
            "format": "double",
            "description": "The transaction amount.",
            "type": "number"
          },
          "distribution_id": {
            "format": "int32",
            "description": "The distribution identifier.",
            "type": "integer"
          },
          "batch_id": {
            "format": "int32",
            "description": "The batch identifier",
            "type": "integer"
          },
          "distribution_amount": {
            "format": "double",
            "description": "The distribution amount.",
            "type": "number"
          },
          "account_number": {
            "description": "The account number.",
            "type": "string"
          },
          "account_class": {
            "description": "The account class.",
            "type": "string"
          },
          "ui_project_id": {
            "description": "The project user-visible identifier.",
            "type": "string"
          },
          "post_date": {
            "format": "date-time",
            "description": "The transaction post date.",
            "type": "string"
          },
          "type_code": {
            "description": "The transaction type (debit or credit).",
            "enum": [
              "Debit",
              "Credit"
            ],
            "type": "string"
          },
          "reference": {
            "description": "The transaction reference.",
            "type": "string"
          },
          "journal": {
            "description": "The full name of the journal.",
            "type": "string"
          },
          "encumbrance": {
            "description": "The transaction encumbrance type.",
            "type": "string"
          },
          "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"
                },
                "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 transaction distribution.",
            "type": "string"
          },
          "added_by": {
            "description": "The creator of the transaction distribution.",
            "type": "string"
          },
          "date_modified": {
            "format": "date-time",
            "description": "The modified date of the transaction distribution.",
            "type": "string"
          },
          "modified_by": {
            "description": "The modifier of the transaction distribution.",
            "type": "string"
          },
          "post_status": {
            "description": "The post status of the transaction distribution.",
            "enum": [
              "Posted",
              "NotYetPosted"
            ],
            "type": "string"
          }
        },
        "x-display-name": "Transaction distribution"
      }
    }
  },
  "x-hidden": true,
  "x-display-name": "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"
    },
    "Details": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "ErrorPath": {
      "type": "string"
    }
  },
  "x-display-name": "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-display-name": "Basic error message"
}

Response 502 Bad Gateway

{
  "Error": "Invalid Request",
  "Details": [
    "The value 'fake' is not valid for transaction_status."
  ],
  "ErrorPath": null
}

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}&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}"
-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", "{access token}");

            // Request parameters
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["account_number"] = "{string}";
            queryString["ui_project_id"] = "{string}";
            queryString["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}";
            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("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}");

            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}",
            "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}",
        };

        $.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}",
                         @"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}",
                      ];

    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}',
    '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}',
);

$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}',
    '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}',
})

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}',
    '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}',
})

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}',
    '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}'
})
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

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