Treasury (Beta)

This API is used to manage bank accounts and transactions.

POST Adjustment

Creates a new adjustment.

Try it

Request URL

Request parameters

bank_account_id Property is required integer

The bank account identifier for this adjustment.

Request headers

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

{
  "category": "string",
  "number": 0,
  "date": "string",
  "amount": 0.0,
  "type": "string",
  "transfer_to_account": 0,
  "reference": "string",
  "is_cleared": true,
  "cleared_date": "string",
  "post_status": "NotYetPosted",
  "post_date": "string",
  "distributions": [
    {
      "distribution_id": 0,
      "amount": 0.0,
      "account_number": "string",
      "type_code": "Debit",
      "distribution_splits": [
        {
          "distribution_split_id": 0,
          "ui_project_id": "string",
          "transaction_code_values": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "amount": 0.0,
          "percent": 0.0,
          "account_class": "string"
        }
      ]
    }
  ],
  "interfund_entry_set": "string"
}
{
  "description": "CreateAdjustment class.",
  "required": [
    "category",
    "amount",
    "type",
    "reference",
    "is_cleared"
  ],
  "type": "object",
  "properties": {
    "category": {
      "description": "The category for this adjustment.",
      "type": "string"
    },
    "number": {
      "format": "int32",
      "description": "The number for this adjustment.",
      "type": "integer"
    },
    "date": {
      "format": "date-time",
      "description": "The date for this adjustment.",
      "type": "string"
    },
    "amount": {
      "format": "double",
      "description": "The amount for this adjustment.",
      "type": "number"
    },
    "type": {
      "description": "The adjustment type for this adjustment.",
      "type": "string"
    },
    "transfer_to_account": {
      "format": "int32",
      "description": "The identifier for the account to transfer to for this adjustment.",
      "type": "integer"
    },
    "reference": {
      "description": "The reference for this adjustment.",
      "type": "string"
    },
    "is_cleared": {
      "description": "The boolean value to determine if adjustment is cleared or not.",
      "type": "boolean"
    },
    "cleared_date": {
      "format": "date-time",
      "description": "The cleared date for this adjustment.",
      "type": "string"
    },
    "post_status": {
      "description": "The post status for this adjustment.",
      "enum": [
        "NotYetPosted",
        "DoNotPost",
        "Posted"
      ],
      "type": "string"
    },
    "post_date": {
      "format": "date-time",
      "description": "The post date for this adjustment.",
      "type": "string"
    },
    "distributions": {
      "description": "The distributions for this adjustment.",
      "type": "array",
      "items": {
        "description": "Distribution.",
        "required": [
          "distribution_splits"
        ],
        "type": "object",
        "properties": {
          "distribution_id": {
            "format": "int32",
            "description": "The distribution identifier.",
            "type": "integer"
          },
          "amount": {
            "format": "double",
            "description": "The distribution amount.",
            "type": "number"
          },
          "account_number": {
            "description": "The account number for this distribution",
            "type": "string"
          },
          "type_code": {
            "description": "The journal entry transaction type (debit or credit).",
            "enum": [
              "Debit",
              "Credit"
            ],
            "type": "string"
          },
          "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"
                },
                "ui_project_id": {
                  "description": "The user-visible identifier of the project.",
                  "type": "string"
                },
                "transaction_code_values": {
                  "description": "The distribution transaction code values.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "The name for this transaction code.",
                        "type": "string"
                      },
                      "value": {
                        "description": "The value of this transaction code.",
                        "type": "string"
                      }
                    },
                    "x-display-name": "Transaction code value"
                  }
                },
                "amount": {
                  "format": "double",
                  "description": "The distribution journal entry amount. Only one of amount or percent can be specified.",
                  "type": "number"
                },
                "percent": {
                  "format": "double",
                  "description": "The distribution journal entry amount percentage. Only one of amount or percent can be specified.",
                  "type": "number"
                },
                "account_class": {
                  "description": "The account class for this distribution split.",
                  "type": "string"
                }
              },
              "x-display-name": "Distribution split"
            }
          }
        },
        "x-hidden": true,
        "x-display-name": "Create distribution"
      }
    },
    "interfund_entry_set": {
      "description": "The interfund entry set for this adjustment.",
      "type": "string"
    }
  },
  "x-hidden": true,
  "x-display-name": "Create adjustment"
}

Response 201

Returned when the operation is successful. The response body contains the specified adjustment.

{
  "record_id": 0
}
{
  "type": "object",
  "properties": {
    "record_id": {
      "format": "int32",
      "type": "integer"
    }
  },
  "x-hidden": true,
  "x-display-name": "Created result `1"
}

Response 400

Returned when the request is not in the correct format.

Response 403

Returned when the user does not have permission to create an adjustment.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/treasury/v1/bankaccounts/{bank_account_id}/adjustments"
-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}/adjustments?" + queryString;

            HttpResponseMessage response;

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


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

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