General Ledger

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

GET

Fiscal year (List)

Returns the list of fiscal year details.

Try it

Request URL

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 fiscal year details.

{
  "count": 21,
  "value": [
    {
      "fiscal_year_id": 1,
      "year": "2000",
      "description": "Fiscal Year 2000",
      "start_date": "2000-01-01T00:00:00",
      "end_date": "2000-12-31T00:00:00",
      "status": "Purged",
      "fiscal_periods": [
        {
          "fiscal_period_id": 1,
          "start_date": "2000-01-01T00:00:00",
          "end_date": "2000-01-31T00:00:00",
          "sequence": 1,
          "closed": true
        },
        {
          "fiscal_period_id": 2,
          "start_date": "2000-02-01T00:00:00",
          "end_date": "2000-02-29T00:00:00",
          "sequence": 2,
          "closed": true
        },
        {
          "fiscal_period_id": 3,
          "start_date": "2000-03-01T00:00:00",
          "end_date": "2000-03-31T00:00:00",
          "sequence": 3,
          "closed": true
        },
        {
          "fiscal_period_id": 4,
          "start_date": "2000-04-01T00:00:00",
          "end_date": "2000-04-30T00:00:00",
          "sequence": 4,
          "closed": true
        },
        {
          "fiscal_period_id": 5,
          "start_date": "2000-05-01T00:00:00",
          "end_date": "2000-05-31T00:00:00",
          "sequence": 5,
          "closed": true
        },
        {
          "fiscal_period_id": 6,
          "start_date": "2000-06-01T00:00:00",
          "end_date": "2000-06-30T00:00:00",
          "sequence": 6,
          "closed": true
        },
        {
          "fiscal_period_id": 7,
          "start_date": "2000-07-01T00:00:00",
          "end_date": "2000-07-31T00:00:00",
          "sequence": 7,
          "closed": true
        },
        {
          "fiscal_period_id": 8,
          "start_date": "2000-08-01T00:00:00",
          "end_date": "2000-08-31T00:00:00",
          "sequence": 8,
          "closed": true
        },
        {
          "fiscal_period_id": 9,
          "start_date": "2000-09-01T00:00:00",
          "end_date": "2000-09-30T00:00:00",
          "sequence": 9,
          "closed": true
        },
        {
          "fiscal_period_id": 10,
          "start_date": "2000-10-01T00:00:00",
          "end_date": "2000-10-31T00:00:00",
          "sequence": 10,
          "closed": true
        },
        {
          "fiscal_period_id": 11,
          "start_date": "2000-11-01T00:00:00",
          "end_date": "2000-11-30T00:00:00",
          "sequence": 11,
          "closed": true
        },
        {
          "fiscal_period_id": 12,
          "start_date": "2000-12-01T00:00:00",
          "end_date": "2000-12-31T00:00:00",
          "sequence": 12,
          "closed": true
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "type": "integer",
      "x-ms-summary": "Count"
    },
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fiscal_year_id": {
            "format": "int32",
            "description": "The identifier for this fiscal year.",
            "type": "integer",
            "x-ms-summary": "Fiscal year id"
          },
          "year": {
            "description": "The year of this fiscal year.",
            "type": "string",
            "x-ms-summary": "Year"
          },
          "description": {
            "description": "The description of this fiscal year.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "start_date": {
            "format": "date-time",
            "description": "The start date for this fiscal year.",
            "type": "string",
            "x-ms-summary": "Start date"
          },
          "end_date": {
            "format": "date-time",
            "description": "The end date for this fiscal year.",
            "type": "string",
            "x-ms-summary": "End date"
          },
          "status": {
            "description": "The status of this fiscal year.",
            "enum": [
              "Open",
              "PreClosed",
              "Closed",
              "Purged",
              "Optimized"
            ],
            "type": "string",
            "x-ms-summary": "Status"
          },
          "fiscal_periods": {
            "description": "The fiscal periods for this fiscal year.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "fiscal_period_id": {
                  "format": "int32",
                  "description": "The identifier for this fiscal period.",
                  "type": "integer",
                  "x-ms-summary": "Fiscal period id"
                },
                "start_date": {
                  "format": "date-time",
                  "description": "The start date for this fiscal period.",
                  "type": "string",
                  "x-ms-summary": "Start date"
                },
                "end_date": {
                  "format": "date-time",
                  "description": "The end date for this fiscal period.",
                  "type": "string",
                  "x-ms-summary": "End date"
                },
                "sequence": {
                  "format": "int32",
                  "description": "The sequence of this fiscal period.",
                  "type": "integer",
                  "x-ms-summary": "Sequence"
                },
                "closed": {
                  "description": "If or not this fiscal period is closed.",
                  "type": "boolean",
                  "x-ms-summary": "Closed"
                }
              },
              "x-display-name": "Fiscal period",
              "x-ms-summary": "Fiscal period"
            },
            "x-ms-summary": "Fiscal periods"
          }
        },
        "x-display-name": "Fiscal year",
        "x-ms-summary": "Fiscal year"
      },
      "x-ms-summary": "Value"
    }
  },
  "x-hidden": true,
  "x-display-name": "Api collection `1",
  "x-ms-summary": "Api collection `1"
}

Response 403 Forbidden

Returned when the user does not have permission to view fiscal year details.

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

            var uri = "https://api.sky.blackbaud.com/generalledger/v1/fiscalyears?" + 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/fiscalyears");


            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/fiscalyears?" + $.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/fiscalyears";
    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/fiscalyears');
$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/fiscalyears?%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/fiscalyears?%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/fiscalyears')

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!