Accounts Payable

This API is used to manage accounts payable, including vendors and invoices.

POST

Note

Returns the identifier of the new note.

Try it

Request URL

Request parameters

Parameter Required Type Description
vendor_id Property is required integer

The vendor to which to add this note.

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 note we are adding to this vendor.

{
  "note_type": "Note",
  "date": "2018-06-27T20:26:06.167Z",
  "content": "This is a note",
  "description": "Note description",
  "type": "Other",
  "is_complete": true,
  "assign_to": "Benton",
  "completed_date": "2018-06-27T20:26:06.167Z"
}
{
  "type": "object",
  "properties": {
    "note_type": {
      "description": "The type of this object - note, or action.",
      "enum": [
        "Note",
        "Action"
      ],
      "type": "string",
      "x-ms-summary": "Note type"
    },
    "date": {
      "format": "date-time",
      "description": "Gets or sets the date.",
      "type": "string",
      "x-ms-summary": "Date"
    },
    "content": {
      "description": "Gets or sets the content.",
      "type": "string",
      "x-ms-summary": "Content"
    },
    "description": {
      "description": "Gets or sets the description.",
      "type": "string",
      "x-ms-summary": "Description"
    },
    "type": {
      "description": "Gets or sets the action or note type.",
      "type": "string",
      "x-ms-summary": "Type"
    },
    "is_complete": {
      "description": "Gets or sets the bool value.",
      "type": "boolean",
      "x-ms-summary": "Is complete"
    },
    "assign_to": {
      "description": "Gets or sets the assign to.",
      "type": "string",
      "x-ms-summary": "Assign to"
    },
    "completed_date": {
      "format": "date-time",
      "description": "Gets or sets the date.",
      "type": "string",
      "x-ms-summary": "Completed date"
    }
  },
  "example": {
    "note_type": "Note",
    "date": "2018-06-27T20:26:06.167Z",
    "content": "This is a note",
    "description": "Note description",
    "type": "Other",
    "is_complete": true,
    "assign_to": "Benton",
    "completed_date": "2018-06-27T20:26:06.167Z"
  },
  "x-hidden": true,
  "x-display-name": "Create vendor note action",
  "x-ms-summary": "Create vendor note action"
}

Response 200 OK

Returned when the operation is successful. The response body contains the ID of the created vendor note.

{
  "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 a vendor note.

{
  "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 no vendor is found with the specified ID.

{
  "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/accountspayable/v1/vendors/{vendor_id}/notes"
-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/accountspayable/v1/vendors/{vendor_id}/notes?" + 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/accountspayable/v1/vendors/{vendor_id}/notes");


            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/accountspayable/v1/vendors/{vendor_id}/notes?" + $.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/accountspayable/v1/vendors/{vendor_id}/notes";
    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/accountspayable/v1/vendors/{vendor_id}/notes');
$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", "/accountspayable/v1/vendors/{vendor_id}/notes?%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", "/accountspayable/v1/vendors/{vendor_id}/notes?%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/accountspayable/v1/vendors/{vendor_id}/notes')

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!