Treasury

This API is used to manage bank accounts and transactions.

GET

Payment

Returns an individual payment with distribution information.

Try it

Request URL

Request parameters

Parameter Required Type Description
payment_id Property is required integer

The identifier for this payment.

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 individual payment and distribution information.

{
  "transaction_type": "ComputerCheck",
  "bank_account_id": 1,
  "amount": 150,
  "check_number": "8675309",
  "transaction_status": "Outstanding",
  "post_status": "Posted",
  "post_date": "2016-07-18T00:00:00Z",
  "reconciled_date": null,
  "cleared_date": null,
  "void_date": null,
  "payee": "A+ Office Supplies",
  "vendor_id": 27,
  "vendor_address_summary": {
    "address_id": 8540,
    "description": "Address description",
    "country": "United States",
    "city": "Charleston",
    "state": "SC",
    "postal": "29412",
    "address_line": "1 Primary Drive",
    "county": ""
  },
  "distributions": [
    {
      "distribution_id": 146451,
      "amount": 15,
      "description": "Debit description",
      "account_number": "01-2000-00",
      "type_code": "Debit",
      "custom_fields": [],
      "distribution_splits": [
        {
          "distribution_split_id": 168079,
          "ui_project_id": "",
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable/Non-Spendable",
              "value": "Spendable",
              "id": 2
            },
            {
              "name": "Performance",
              "value": "Regular",
              "id": 3
            },
            {
              "name": "The Raiser's Edge",
              "value": "",
              "id": 4
            }
          ],
          "amount": 150,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ]
    },
    {
      "distribution_id": 146452,
      "amount": 150,
      "description": "Credit description",
      "account_number": "01-5000-00",
      "type_code": "Credit",
      "custom_fields": [],
      "distribution_splits": [
        {
          "distribution_split_id": 168080,
          "ui_project_id": "",
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable/Non-Spendable",
              "value": "Spendable",
              "id": 2
            },
            {
              "name": "Performance",
              "value": "Regular",
              "id": 3
            },
            {
              "name": "The Raiser's Edge",
              "value": "2013 Capital Campaign Email",
              "id": 4
            }
          ],
          "amount": 150,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ]
    }
  ]
}
{
  "description": "Class for payment detail",
  "type": "object",
  "properties": {
    "transaction_type": {
      "description": "The type of payment.",
      "enum": [
        "ComputerCheck",
        "ManualCheck",
        "OneTimeCheck",
        "EFTCheck",
        "BankDraft",
        "Deposit",
        "AdjustmentTransferOut",
        "AdjustmentTransferIn",
        "AdjustmentPayment",
        "AdjustmentDeposit",
        "CreditCardCharge",
        "CreditCardPayment",
        "AdjustmentPaymentCredit",
        "AdjustmentCharge"
      ],
      "type": "string",
      "x-ms-summary": "Transaction type"
    },
    "bank_account_id": {
      "format": "int32",
      "description": "The parent bank account identifier of the payment.",
      "type": "integer",
      "x-ms-summary": "Bank account id"
    },
    "amount": {
      "format": "double",
      "description": "The amount of the payment.",
      "type": "number",
      "x-ms-summary": "Amount"
    },
    "check_number": {
      "description": "The check number of the payment.",
      "type": "string",
      "x-ms-summary": "Check number"
    },
    "transaction_status": {
      "description": "The transaction status of the payment.",
      "enum": [
        "Outstanding",
        "Cleared",
        "Reconciled",
        "Voided"
      ],
      "type": "string",
      "x-ms-summary": "Transaction status"
    },
    "post_status": {
      "description": "The post status of the payment.",
      "enum": [
        "DoNotPost",
        "NotYetPosted",
        "Posted"
      ],
      "type": "string",
      "x-ms-summary": "Post status"
    },
    "post_date": {
      "format": "date-time",
      "description": "The post date of the payment.",
      "type": "string",
      "x-ms-summary": "Post date"
    },
    "reconciled_date": {
      "format": "date-time",
      "description": "The reconciled date of the payment.",
      "type": "string",
      "x-ms-summary": "Reconciled date"
    },
    "cleared_date": {
      "format": "date-time",
      "description": "The cleared date of the payment.",
      "type": "string",
      "x-ms-summary": "Cleared date"
    },
    "void_date": {
      "format": "date-time",
      "description": "The void date of the payment.",
      "type": "string",
      "x-ms-summary": "Void date"
    },
    "payee": {
      "description": "The parent vendor name of the payment.",
      "type": "string",
      "x-ms-summary": "Payee"
    },
    "vendor_id": {
      "format": "int32",
      "description": "The parent vendor identifier of the payment.",
      "type": "integer",
      "x-ms-summary": "Vendor id"
    },
    "vendor_address_summary": {
      "description": "The parent vendor address summary of the payment.",
      "type": "object",
      "properties": {
        "address_id": {
          "format": "int32",
          "description": "The identifier of the address.",
          "type": "integer",
          "x-ms-summary": "Address id"
        },
        "description": {
          "description": "The description of the address.",
          "type": "string",
          "x-ms-summary": "Description"
        },
        "country": {
          "description": "The country of the address.",
          "type": "string",
          "x-ms-summary": "Country"
        },
        "city": {
          "description": "The city of the address.",
          "type": "string",
          "x-ms-summary": "City"
        },
        "state": {
          "description": "The state of the address.",
          "type": "string",
          "x-ms-summary": "State"
        },
        "postal": {
          "description": "The postal code of the address.",
          "type": "string",
          "x-ms-summary": "Postal"
        },
        "address_line": {
          "description": "The address line of the address.",
          "type": "string",
          "x-ms-summary": "Address line"
        },
        "county": {
          "description": "The county of the address.",
          "type": "string",
          "x-ms-summary": "County"
        }
      },
      "x-display-name": "Address summary",
      "x-ms-summary": "Vendor address summary"
    },
    "distributions": {
      "description": "The distributions of the payment.",
      "type": "array",
      "items": {
        "description": "Distribution.",
        "required": [
          "distribution_splits"
        ],
        "type": "object",
        "properties": {
          "distribution_id": {
            "format": "int32",
            "description": "The distribution identifier.",
            "type": "integer",
            "x-ms-summary": "Distribution id"
          },
          "amount": {
            "format": "double",
            "description": "The distribution amount.",
            "type": "number",
            "x-ms-summary": "Amount"
          },
          "description": {
            "description": "The description for this distribution.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "account_number": {
            "description": "The account number for this distribution.",
            "type": "string",
            "x-ms-summary": "Account number"
          },
          "type_code": {
            "description": "The journal entry transaction type (debit or credit).",
            "enum": [
              "Debit",
              "Credit"
            ],
            "type": "string",
            "x-ms-summary": "Type code"
          },
          "custom_fields": {
            "description": "The custom fields for this distribution.",
            "type": "array",
            "items": {
              "description": "Custom field definition.",
              "type": "object",
              "properties": {
                "field_name": {
                  "description": "The name of the custom field.",
                  "type": "string",
                  "x-ms-summary": "Field name"
                },
                "value": {
                  "description": "The value for this custom field.",
                  "type": "string",
                  "x-ms-summary": "Value"
                },
                "comments": {
                  "description": "The description for this custom field.",
                  "type": "string",
                  "x-ms-summary": "Comments"
                },
                "type": {
                  "description": "The type of this custom field.",
                  "enum": [
                    "Text",
                    "Number",
                    "DateTime",
                    "Currency",
                    "Boolean",
                    "Table",
                    "FuzzyDate"
                  ],
                  "type": "string",
                  "x-ms-summary": "Type"
                },
                "is_required": {
                  "description": "If this custom field is required.",
                  "type": "boolean",
                  "x-ms-summary": "Is required"
                },
                "date": {
                  "format": "date-time",
                  "description": "The date on this custom field.",
                  "type": "string",
                  "x-ms-summary": "Date"
                }
              },
              "x-display-name": "Custom field",
              "x-ms-summary": "Custom field"
            },
            "x-ms-summary": "Custom fields"
          },
          "distribution_splits": {
            "description": "The distribution split.",
            "type": "array",
            "items": {
              "description": "Journal Entry Distribution.",
              "required": [
                "transaction_code_values"
              ],
              "type": "object",
              "properties": {
                "distribution_split_id": {
                  "format": "int32",
                  "description": "The distribution split identifier.",
                  "type": "integer",
                  "x-ms-summary": "Distribution split id"
                },
                "ui_project_id": {
                  "description": "The user-visible identifier of the project.",
                  "type": "string",
                  "x-ms-summary": "Ui project id"
                },
                "transaction_code_values": {
                  "description": "The distribution transaction code values.",
                  "type": "array",
                  "items": {
                    "description": "Transaction code value",
                    "required": [
                      "value",
                      "id"
                    ],
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "The transaction code name.",
                        "type": "string",
                        "x-ms-summary": "Name"
                      },
                      "value": {
                        "description": "The transaction code value.",
                        "type": "string",
                        "x-ms-summary": "Value"
                      },
                      "id": {
                        "format": "int32",
                        "description": "The transaction code value id.",
                        "type": "integer",
                        "x-ms-summary": "Id"
                      },
                      "inactive": {
                        "description": "Indicate if record is inactive or not.",
                        "type": "boolean",
                        "x-ms-summary": "Inactive"
                      }
                    },
                    "x-display-name": "Transaction code value",
                    "x-ms-summary": "Transaction code value"
                  },
                  "x-ms-summary": "Transaction code values"
                },
                "amount": {
                  "format": "double",
                  "description": "The distribution journal entry amount. Only one of amount or percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Amount"
                },
                "percent": {
                  "format": "double",
                  "description": "The distribution journal entry amount percentage. Only one of amount or percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Percent"
                },
                "account_class": {
                  "description": "The account class for this distribution split.",
                  "type": "string",
                  "x-ms-summary": "Account class"
                }
              },
              "x-display-name": "Distribution split",
              "x-ms-summary": "Distribution split"
            },
            "x-ms-summary": "Distribution splits"
          }
        },
        "x-display-name": "Distribution",
        "x-ms-summary": "Distribution"
      },
      "x-ms-summary": "Distributions"
    }
  },
  "x-display-name": "Payment detail",
  "x-ms-summary": "Payment detail"
}

Response 403 Forbidden

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

{
  "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 payment 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/payments/{payment_id}"
-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/treasury/v1/payments/{payment_id}?" + 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/payments/{payment_id}");


            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/treasury/v1/payments/{payment_id}?" + $.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/payments/{payment_id}";
    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/treasury/v1/payments/{payment_id}');
$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", "/treasury/v1/payments/{payment_id}?%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", "/treasury/v1/payments/{payment_id}?%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/payments/{payment_id}')

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!