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

Budget detail

Returns the specified budget details.

Try it

Request URL

Request parameters

Parameter Required Type Description
scenario_id Property is required integer

The identifier for the budget scenario.

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 specified budget.

{
  "scenario_id": "01",
  "description": "Test",
  "budget_type": "FiscalYear",
  "status": "Inactive",
  "start_fiscal_year": "2000-2001 FY",
  "end_fiscal_year": "2000-2001 FY",
  "start_fiscal_period": 1,
  "end_fiscal_period": 12,
  "locked": true,
  "total_revenue": 0,
  "total_expense": 0,
  "added_by": "Supervisor",
  "date_added": "2002-01-29T00:00:00Z",
  "modified_by": "Supervisor",
  "date_modified": "2008-05-19T11:19:26.863Z"
}
{
  "description": "Budget Detail",
  "type": "object",
  "properties": {
    "scenario_id": {
      "description": "The scenario id for this budget.",
      "type": "string",
      "x-ms-summary": "Scenario id"
    },
    "description": {
      "description": "The description for this budget.",
      "type": "string",
      "x-ms-summary": "Description"
    },
    "budget_type": {
      "description": "The budget type for this budget.",
      "enum": [
        "FiscalYear",
        "PeriodRange"
      ],
      "type": "string",
      "x-ms-summary": "Budget type"
    },
    "status": {
      "description": "The status of this budget.",
      "enum": [
        "Active",
        "Inactive"
      ],
      "type": "string",
      "x-ms-summary": "Status"
    },
    "start_fiscal_year": {
      "description": "The start fiscal year for this budget.",
      "type": "string",
      "x-ms-summary": "Start fiscal year"
    },
    "end_fiscal_year": {
      "description": "The end fiscal year for this budget.",
      "type": "string",
      "x-ms-summary": "End fiscal year"
    },
    "start_fiscal_period": {
      "format": "int32",
      "description": "The start fiscal period for this budget.",
      "type": "integer",
      "x-ms-summary": "Start fiscal period"
    },
    "end_fiscal_period": {
      "format": "int32",
      "description": "The end fiscal period for this budget.",
      "type": "integer",
      "x-ms-summary": "End fiscal period"
    },
    "locked": {
      "description": "The status of the lock for this budget.",
      "type": "boolean",
      "x-ms-summary": "Locked"
    },
    "total_revenue": {
      "format": "double",
      "description": "The total revenue for this budget.",
      "type": "number",
      "x-ms-summary": "Total revenue"
    },
    "total_expense": {
      "format": "double",
      "description": "The total expense for this budget.",
      "type": "number",
      "x-ms-summary": "Total expense"
    },
    "added_by": {
      "description": "The name of who added this budget.",
      "type": "string",
      "x-ms-summary": "Added by"
    },
    "date_added": {
      "format": "date-time",
      "description": "The date this budget was added.",
      "type": "string",
      "x-ms-summary": "Date added"
    },
    "modified_by": {
      "description": "The name of who modified this budget.",
      "type": "string",
      "x-ms-summary": "Modified by"
    },
    "date_modified": {
      "format": "date-time",
      "description": "The date this budget was modified.",
      "type": "string",
      "x-ms-summary": "Date modified"
    }
  },
  "x-display-name": "Budget detail",
  "x-ms-summary": "Budget detail"
}

Response 403 Forbidden

Returned when the user does not have permission to view budgets.

{
  "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 budget 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 GET "https://api.sky.blackbaud.com/generalledger/v1/budgets/{scenario_id}/details"
-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/budgets/{scenario_id}/details?" + 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/budgets/{scenario_id}/details");


            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/budgets/{scenario_id}/details?" + $.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/budgets/{scenario_id}/details";
    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/budgets/{scenario_id}/details');
$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/budgets/{scenario_id}/details?%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/budgets/{scenario_id}/details?%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/budgets/{scenario_id}/details')

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!