General Ledger

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

PATCH

Cash management distribution set

Returns the identifier of the edited cash management distribution set.

Try it

Request URL

Request parameters

Parameter Required Type Description
set_id Property is required integer

The identifier of the cash management distribution set to edit.

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 changes for the cash management distribution set.

{
  "name": "Distribution E1",
  "line_items": [
    {
      "percent": 100,
      "row_number": 1,
      "account_id": 372,
      "custom_fields": [],
      "project_line_items": [
        {
          "percent": 70,
          "line_number": 1,
          "project_id": 7,
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 0
            },
            {
              "name": "Spendable/Non-Spendable",
              "value": "Spendable",
              "id": 233
            }
          ],
          "account_class": "Unrestricted Net Assets"
        },
        {
          "percent": 30,
          "line_number": 2,
          "project_id": 3,
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 0
            }
          ],
          "account_class": "Unrestricted Net Assets"
        }
      ]
    }
  ]
}
{
  "description": "Cash management distribution set.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the cash management distribution set.",
      "type": "string",
      "x-ms-summary": "Name"
    },
    "line_items": {
      "description": "The line items for the cash management distribution set.",
      "type": "array",
      "items": {
        "description": "Cash management distribution set line item.",
        "required": [
          "percent",
          "account_id",
          "project_line_items"
        ],
        "type": "object",
        "properties": {
          "percent": {
            "format": "double",
            "description": "The percent of the cash management distribution set the line item represents.",
            "type": "number",
            "x-ms-summary": "Percent"
          },
          "account_id": {
            "format": "int32",
            "description": "The identifier of the account for the line item.",
            "type": "integer",
            "x-ms-summary": "Account id"
          },
          "custom_fields": {
            "description": "Custom fields for the line item.",
            "type": "array",
            "items": {
              "description": "Custom field definition.",
              "type": "object",
              "properties": {
                "custom_field_id": {
                  "format": "int32",
                  "description": "The identifier for this custom field.",
                  "type": "integer",
                  "x-ms-summary": "Custom field id"
                },
                "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"
                },
                "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"
          },
          "project_line_items": {
            "description": "The project distribution for the line item.",
            "type": "array",
            "items": {
              "description": "Cash management distribution set line item.",
              "required": [
                "percent",
                "transaction_code_values"
              ],
              "type": "object",
              "properties": {
                "percent": {
                  "format": "double",
                  "description": "The percent of the cash management distribution set the line item represents.",
                  "type": "number",
                  "x-ms-summary": "Percent"
                },
                "project_id": {
                  "format": "int32",
                  "description": "The idenifier of the project for the line item.",
                  "type": "integer",
                  "x-ms-summary": "Project id"
                },
                "transaction_code_values": {
                  "description": "The transaction code values for the line item.",
                  "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"
                      }
                    },
                    "x-display-name": "Transaction code value",
                    "x-ms-summary": "Transaction code value"
                  },
                  "x-ms-summary": "Transaction code values"
                },
                "account_class": {
                  "description": "The class of the account for the line item.",
                  "type": "string",
                  "x-ms-summary": "Account class"
                }
              },
              "x-display-name": "Edit distribution set project line item",
              "x-ms-summary": "Edit distribution set project line item"
            },
            "x-ms-summary": "Project line items"
          }
        },
        "x-display-name": "Edit cash management distribution set line item",
        "x-ms-summary": "Edit cash management distribution set line item"
      },
      "x-ms-summary": "Line items"
    }
  },
  "example": {
    "name": "Distribution E1",
    "line_items": [
      {
        "percent": 100,
        "row_number": 1,
        "account_id": 372,
        "custom_fields": [],
        "project_line_items": [
          {
            "percent": 70,
            "line_number": 1,
            "project_id": 7,
            "transaction_code_values": [
              {
                "name": "Grants",
                "value": "None",
                "id": 0
              },
              {
                "name": "Spendable/Non-Spendable",
                "value": "Spendable",
                "id": 233
              }
            ],
            "account_class": "Unrestricted Net Assets"
          },
          {
            "percent": 30,
            "line_number": 2,
            "project_id": 3,
            "transaction_code_values": [
              {
                "name": "Grants",
                "value": "None",
                "id": 0
              }
            ],
            "account_class": "Unrestricted Net Assets"
          }
        ]
      }
    ]
  },
  "x-display-name": "Edit cash management distribution set",
  "x-ms-summary": "Edit cash management distribution set"
}

Response 200 OK

Returned when the operation is successful. The response body contains the identifier for the cash management distribution set.

{
  "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": "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 edit cash management distribution sets.

{
  "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 cash management distribution set 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 PATCH "https://api.sky.blackbaud.com/generalledger/v1/distributionsets/cashmanagement/{set_id}"
-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/generalledger/v1/distributionsets/cashmanagement/{set_id}?" + 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 request = new HttpRequestMessage(new HttpMethod("PATCH"), uri);
               request.Content = content;

               var response = await client.SendAsync(request);
            }

        }
    }
}
// // 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/distributionsets/cashmanagement/{set_id}");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(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/generalledger/v1/distributionsets/cashmanagement/{set_id}?" + $.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: "PATCH",
            // 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/distributionsets/cashmanagement/{set_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:@"PATCH"];
    // 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/generalledger/v1/distributionsets/cashmanagement/{set_id}');
$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_PATCH);

// 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("PATCH", "/generalledger/v1/distributionsets/cashmanagement/{set_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
    '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("PATCH", "/generalledger/v1/distributionsets/cashmanagement/{set_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/generalledger/v1/distributionsets/cashmanagement/{set_id}')

request = Net::HTTP::Patch.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!