General Ledger

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

POST

Budget

Returns the identifier for the newly created budget scenario.

Try it

Request URL

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

Request body

The budget scenario to create.

{
  "scenario_id": "Scenario2",
  "start_period": 1,
  "end_period": 3,
  "start_fiscal_year": "2018",
  "end_fiscal_year": "2018",
  "budget_type": "PeriodRange",
  "lines": [
    {
      "account_number": "01-1000-00",
      "project_id": "1100",
      "grant_description": "None",
      "notes": "Some note",
      "total": 30.0,
      "periods": [
        {
          "amount": 10.0,
          "sequence": 1,
          "year_id": "2018"
        },
        {
          "amount": 10.0,
          "sequence": 2,
          "year_id": "2018"
        },
        {
          "amount": 10.0,
          "sequence": 3,
          "year_id": "2018"
        }
      ]
    }
  ]
}
{
  "description": "Contract for creating budget.",
  "required": [
    "scenario_id",
    "start_period",
    "end_period",
    "start_fiscal_year",
    "end_fiscal_year",
    "budget_type",
    "lines"
  ],
  "type": "object",
  "properties": {
    "scenario_id": {
      "description": "The description for the scenario.",
      "type": "string",
      "x-ms-summary": "Scenario id"
    },
    "start_period": {
      "format": "int32",
      "description": "The first period of the starting fiscal year of the budget.",
      "type": "integer",
      "x-ms-summary": "Start period"
    },
    "end_period": {
      "format": "int32",
      "description": "The last period of the end fiscal year of the budget.",
      "type": "integer",
      "x-ms-summary": "End period"
    },
    "start_fiscal_year": {
      "description": "The starting fiscal year of the budget.",
      "type": "string",
      "x-ms-summary": "Start fiscal year"
    },
    "end_fiscal_year": {
      "description": "The ending fiscal year of the budget.",
      "type": "string",
      "x-ms-summary": "End fiscal year"
    },
    "budget_type": {
      "description": "The type of the budget.",
      "enum": [
        "FiscalYear",
        "PeriodRange"
      ],
      "type": "string",
      "x-ms-summary": "Budget type"
    },
    "lines": {
      "description": "The list of budget lines for this budget scenario.",
      "type": "array",
      "items": {
        "description": "Budget line",
        "required": [
          "account_number",
          "total",
          "periods"
        ],
        "type": "object",
        "properties": {
          "account_number": {
            "description": "The number for an account on this budget.",
            "type": "string",
            "x-ms-summary": "Account number"
          },
          "budget_line_id": {
            "format": "int32",
            "type": "integer",
            "x-ms-summary": "Budget line id"
          },
          "project_id": {
            "description": "The project id for this budget line.",
            "type": "string",
            "x-ms-summary": "Project id"
          },
          "grant_description": {
            "description": "The description of the {Grant} t-code.",
            "type": "string",
            "x-ms-summary": "Grant description"
          },
          "total": {
            "format": "double",
            "description": "The total amount for this budget line.",
            "type": "number",
            "x-ms-summary": "Total"
          },
          "periods": {
            "description": "The period distributions for this budget line.",
            "type": "array",
            "items": {
              "description": "Budget period info",
              "required": [
                "amount",
                "sequence",
                "year_id"
              ],
              "type": "object",
              "properties": {
                "amount": {
                  "format": "double",
                  "description": "The amount for this period.",
                  "type": "number",
                  "x-ms-summary": "Amount"
                },
                "sequence": {
                  "format": "int32",
                  "description": "The sequence number of the fiscal year of this period.",
                  "type": "integer",
                  "x-ms-summary": "Sequence"
                },
                "year_id": {
                  "description": "The fiscal year of this period.",
                  "type": "string",
                  "x-ms-summary": "Year id"
                }
              },
              "x-display-name": "Budget period info",
              "x-ms-summary": "Budget period info"
            },
            "x-ms-summary": "Periods"
          }
        },
        "x-display-name": "Create budget line",
        "x-ms-summary": "Create budget line"
      },
      "x-ms-summary": "Lines"
    }
  },
  "example": {
    "scenario_id": "Scenario2",
    "start_period": 1,
    "end_period": 3,
    "start_fiscal_year": "2018",
    "end_fiscal_year": "2018",
    "budget_type": "PeriodRange",
    "lines": [
      {
        "account_number": "01-1000-00",
        "project_id": "1100",
        "grant_description": "None",
        "notes": "Some note",
        "total": 30.0,
        "periods": [
          {
            "amount": 10.0,
            "sequence": 1,
            "year_id": "2018"
          },
          {
            "amount": 10.0,
            "sequence": 2,
            "year_id": "2018"
          },
          {
            "amount": 10.0,
            "sequence": 3,
            "year_id": "2018"
          }
        ]
      }
    ]
  },
  "x-display-name": "Create budget",
  "x-ms-summary": "Create budget"
}

Response 200 OK

Returned when the operation is successful. The response body contains the identifier for the new budget.

{
  "id": 843
}
{
  "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 specified journal entries are 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 create 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"
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/generalledger/v1/budgets"
-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/budgets?" + 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 response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // 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");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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/budgets?" + $.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: "POST",
            // 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";
    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:@"POST"];
    // 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/budgets');
$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_POST);

// 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("POST", "/generalledger/v1/budgets?%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("POST", "/generalledger/v1/budgets?%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')

request = Net::HTTP::Post.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

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!