Treasury

This API is used to manage bank accounts and transactions.

GET

Checks (List)

Returns a list of bank account checks.

Try it

Request URL

Request parameters

Parameter Required Type Description
bank_account_id Property is required integer

The bank account identifier for this bank account register.
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 500.
transaction_status string

The transaction status of records to return.
post_status string

The post status of records to return.
check_type string

The check type of records to return.
starting_check_number integer

The starting check number of checks to return.
ending_check_number integer

The ending check number of checks to return.

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 of bank account checks.

{
  "count": 955,
  "value": [
    {
      "check_id": 88,
      "transaction_id": 230,
      "date": "2005-01-13T00:00:00",
      "amount": 4410.0,
      "number": 1075,
      "transaction_status": "Reconciled",
      "subledger": "Payables",
      "post_status": "Posted",
      "post_date": "2005-01-13T00:00:00",
      "check_type": "ComputerCheck",
      "payee": "AlphaGraphics"
    },
    {
      "check_id": 89,
      "transaction_id": 231,
      "date": "2005-01-13T00:00:00",
      "amount": 4900.0,
      "number": 1076,
      "transaction_status": "Reconciled",
      "subledger": "Payables",
      "post_status": "Posted",
      "post_date": "2005-01-13T00:00:00",
      "check_type": "ComputerCheck",
      "payee": "Southern Utilities"
    },
    {
      "check_id": 90,
      "transaction_id": 232,
      "date": "2006-01-13T00:00:00",
      "amount": 4410.0,
      "number": 1077,
      "transaction_status": "Reconciled",
      "subledger": "Payables",
      "post_status": "Posted",
      "post_date": "2005-01-13T00:00:00",
      "check_type": "ComputerCheck",
      "payee": "AlphaGraphics"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "type": "integer",
      "x-ms-summary": "Count"
    },
    "value": {
      "type": "array",
      "items": {
        "description": "Check information",
        "type": "object",
        "properties": {
          "check_id": {
            "format": "int32",
            "description": "The identifier for this check.",
            "type": "integer",
            "x-ms-summary": "Check id"
          },
          "transaction_id": {
            "format": "int32",
            "description": "The transaction identifier for this check.",
            "type": "integer",
            "x-ms-summary": "Transaction id"
          },
          "date": {
            "format": "date-time",
            "description": "The date for this check.",
            "type": "string",
            "x-ms-summary": "Date"
          },
          "amount": {
            "format": "double",
            "description": "The payment amount for this check.",
            "type": "number",
            "x-ms-summary": "Amount"
          },
          "number": {
            "format": "int32",
            "description": "The number for this check.",
            "type": "integer",
            "x-ms-summary": "Number"
          },
          "transaction_status": {
            "description": "The status for this check.",
            "enum": [
              "Outstanding",
              "Cleared",
              "Reconciled",
              "Voided"
            ],
            "type": "string",
            "x-ms-summary": "Transaction status"
          },
          "subledger": {
            "description": "The subledger for this check.",
            "type": "string",
            "x-ms-summary": "Subledger"
          },
          "post_status": {
            "description": "The post status for this check.",
            "enum": [
              "DoNotPost",
              "NotYetPosted",
              "Posted"
            ],
            "type": "string",
            "x-ms-summary": "Post status"
          },
          "post_date": {
            "format": "date-time",
            "description": "The post date for this check.",
            "type": "string",
            "x-ms-summary": "Post date"
          },
          "check_type": {
            "description": "The transaction type for this check.",
            "enum": [
              "ManualCheck",
              "ComputerCheck",
              "OneTimeCheck",
              "EFTCheck"
            ],
            "type": "string",
            "x-ms-summary": "Check type"
          },
          "payee": {
            "description": "The payee for this check.",
            "type": "string",
            "x-ms-summary": "Payee"
          }
        },
        "x-display-name": "Check summary",
        "x-ms-summary": "Check summary"
      },
      "x-ms-summary": "Value"
    }
  },
  "x-hidden": true,
  "x-display-name": "Api collection `1",
  "x-ms-summary": "Api collection `1"
}

Response 400 Bad Request

Returned when the request is not in the correct format.

{
  "Error": "Invalid Request",
  "Details": [
    "The value 'fake' is not valid for transaction_status."
  ],
  "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 view the bank account.

{
  "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 the specified bank account could not be found.

{
  "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/treasury/v1/bankaccounts/{bank_account_id}/checks?offset={integer}&limit={integer}&transaction_status={string}&post_status={string}&check_type={string}&starting_check_number={integer}&ending_check_number={integer}"
-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["transaction_status"] = "{string}";
            queryString["post_status"] = "{string}";
            queryString["check_type"] = "{string}";
            queryString["starting_check_number"] = "{integer}";
            queryString["ending_check_number"] = "{integer}";
            var uri = "https://api.sky.blackbaud.com/treasury/v1/bankaccounts/{bank_account_id}/checks?" + 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/treasury/v1/bankaccounts/{bank_account_id}/checks");

            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("transaction_status", "{string}");
            builder.setParameter("post_status", "{string}");
            builder.setParameter("check_type", "{string}");
            builder.setParameter("starting_check_number", "{integer}");
            builder.setParameter("ending_check_number", "{integer}");

            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}",
            "transaction_status": "{string}",
            "post_status": "{string}",
            "check_type": "{string}",
            "starting_check_number": "{integer}",
            "ending_check_number": "{integer}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/treasury/v1/bankaccounts/{bank_account_id}/checks?" + $.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/treasury/v1/bankaccounts/{bank_account_id}/checks";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"transaction_status={string}",
                         @"post_status={string}",
                         @"check_type={string}",
                         @"starting_check_number={integer}",
                         @"ending_check_number={integer}",
                      ];

    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/treasury/v1/bankaccounts/{bank_account_id}/checks');
$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}',
    'transaction_status' => '{string}',
    'post_status' => '{string}',
    'check_type' => '{string}',
    'starting_check_number' => '{integer}',
    'ending_check_number' => '{integer}',
);

$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}',
    'transaction_status': '{string}',
    'post_status': '{string}',
    'check_type': '{string}',
    'starting_check_number': '{integer}',
    'ending_check_number': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/treasury/v1/bankaccounts/{bank_account_id}/checks?%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}',
    'transaction_status': '{string}',
    'post_status': '{string}',
    'check_type': '{string}',
    'starting_check_number': '{integer}',
    'ending_check_number': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/treasury/v1/bankaccounts/{bank_account_id}/checks?%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/treasury/v1/bankaccounts/{bank_account_id}/checks')

query = URI.encode_www_form({
    # Request parameters
    'offset' => '{integer}',
    'limit' => '{integer}',
    'transaction_status' => '{string}',
    'post_status' => '{string}',
    'check_type' => '{string}',
    'starting_check_number' => '{integer}',
    'ending_check_number' => '{integer}'
})
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!