Treasury

This API is used to manage bank accounts and transactions.

POST

Deposit

Adds a new deposit.

Try it

Request URL

Request parameters

Parameter Required Type Description
bank_account_id Property is required integer

The bank account identifier for this deposit.

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 deposit to create.

{
  "number": "843849",
  "type": "MiscellaneousCashReceipts",
  "description": "Deposit description",
  "ui_deposit_id": "200",
  "projected_count": 2,
  "projected_amount": 100.0,
  "date": "2017-02-08T00:00:00",
  "post_status": "NotYetPosted",
  "post_date": "2018-02-08T00:00:00",
  "created_date": "2017-02-08T00:00:00",
  "payment_methods_allowed": [
    "Cash"
  ],
  "transaction_defaults": {
    "receipt_date": "2017-02-08T00:00:00",
    "amount": 100.0,
    "description": "transaction default description",
    "payment_method": "Cash",
    "category": "Grants"
  }
}
{
  "description": "CreateDeposit class.",
  "required": [
    "type",
    "date",
    "created_date",
    "post_status",
    "post_date",
    "payment_methods_allowed"
  ],
  "type": "object",
  "properties": {
    "number": {
      "description": "The number for this deposit.",
      "type": "string",
      "x-ms-summary": "Number"
    },
    "type": {
      "description": "The type for this deposit.",
      "enum": [
        "MiscellaneousCashReceipts"
      ],
      "type": "string",
      "x-ms-summary": "Type"
    },
    "description": {
      "description": "The description for this deposit.",
      "type": "string",
      "x-ms-summary": "Description"
    },
    "ui_deposit_id": {
      "description": "The description for this deposit.",
      "type": "string",
      "x-ms-summary": "Ui deposit id"
    },
    "projected_count": {
      "format": "int32",
      "description": "The projected count for this deposit.",
      "type": "integer",
      "x-ms-summary": "Projected count"
    },
    "projected_amount": {
      "format": "double",
      "description": "The projected amount for this deposit.",
      "type": "number",
      "x-ms-summary": "Projected amount"
    },
    "date": {
      "format": "date-time",
      "description": "The date for this deposit.",
      "type": "string",
      "x-ms-summary": "Date"
    },
    "created_date": {
      "format": "date-time",
      "description": "The created date for this deposit.",
      "type": "string",
      "x-ms-summary": "Created date"
    },
    "post_status": {
      "description": "The post status for this deposit.",
      "enum": [
        "DoNotPost",
        "NotYetPosted",
        "Posted"
      ],
      "type": "string",
      "x-ms-summary": "Post status"
    },
    "post_date": {
      "format": "date-time",
      "description": "The post date for this deposit.",
      "type": "string",
      "x-ms-summary": "Post date"
    },
    "payment_methods_allowed": {
      "description": "The payment methods for this deposit.",
      "type": "array",
      "items": {
        "enum": [
          "Cash",
          "CashiersCheck",
          "Check",
          "COD",
          "CreditCard",
          "ReceivedEFT",
          "Other"
        ],
        "type": "string"
      },
      "x-ms-summary": "Payment methods allowed"
    },
    "transaction_defaults": {
      "description": "The transaction defaults for this deposit.",
      "type": "object",
      "properties": {
        "receipt_date": {
          "format": "date-time",
          "description": "The receipt date for this transaction.",
          "type": "string",
          "x-ms-summary": "Receipt date"
        },
        "amount": {
          "format": "double",
          "description": "The amount for this transaction.",
          "type": "number",
          "x-ms-summary": "Amount"
        },
        "description": {
          "description": "The description for this transaction.",
          "type": "string",
          "x-ms-summary": "Description"
        },
        "payment_method": {
          "description": "The payment method for this transaction.",
          "enum": [
            "Cash",
            "CashiersCheck",
            "Check",
            "COD",
            "CreditCard",
            "ReceivedEFT",
            "Other"
          ],
          "type": "string",
          "x-ms-summary": "Payment method"
        },
        "category": {
          "description": "The category for this transaction.",
          "type": "string",
          "x-ms-summary": "Category"
        }
      },
      "x-display-name": "Transaction defaults",
      "x-ms-summary": "Transaction defaults",
      "x-hidden": true
    }
  },
  "example": {
    "number": "843849",
    "type": "MiscellaneousCashReceipts",
    "description": "Deposit description",
    "ui_deposit_id": "200",
    "projected_count": 2,
    "projected_amount": 100.0,
    "date": "2017-02-08T00:00:00Z",
    "post_status": "NotYetPosted",
    "post_date": "2018-02-08T00:00:00Z",
    "created_date": "2017-02-08T00:00:00Z",
    "payment_methods_allowed": [
      "Cash"
    ],
    "transaction_defaults": {
      "receipt_date": "2017-02-08T00:00:00Z",
      "amount": 100.0,
      "description": "transaction default description",
      "payment_method": "Cash",
      "category": "Grants"
    }
  },
  "x-hidden": true,
  "x-display-name": "Create deposit",
  "x-ms-summary": "Create deposit"
}

Response 200 OK

Returned when the operation is successful. The response body contains the ID of the deposit.

{
  "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 the request is not in the correct format.

{
  "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 deposits.

{
  "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/treasury/v1/bankaccounts/{bank_account_id}/deposits"
-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/treasury/v1/bankaccounts/{bank_account_id}/deposits?" + 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/treasury/v1/bankaccounts/{bank_account_id}/deposits");


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

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!