Accounts Payable

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

GET

Purchase order (List)

Returns a list of purchase order summaries.

Try it

Request URL

Request parameters

Parameter Required Type Description
offset integer

Represents the number of records to skip.

limit integer

Represents the number of records to return.

search_text string

Text to match. Can match vendor_name or order_number. A blank search will match all purchase orders.

type string

Type of purchase order.

from_date string

The minimum order date to include records.

to_date string

The maximum order date to include records.

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 a list of purchase orders.

{
  "count": 245,
  "value": [
    {
      "purchase_order_id": 24,
      "order_number": 12345678901,
      "order_date": "2025-01-01T00:00:00",
      "type": "Template",
      "order_total": 74.98,
      "receipted_total": 0,
      "order_status": "ClosedOrder",
      "vendor_name": "A+ Office Supplies",
      "vendor_id": 31,
      "terms": "Due on Receipt",
      "date_added": "2015-12-01T10:58:37.477",
      "added_by": "BentonAu",
      "date_modified": "2018-08-08T15:10:44.47",
      "modified_by": "Stacy"
    },
    {
      "purchase_order_id": 1044,
      "order_number": 129,
      "order_date": "2018-08-16T00:00:00",
      "type": "Template",
      "order_total": 0,
      "receipted_total": 0,
      "order_status": "UnprintedPurchaseOrder",
      "vendor_name": "Test vendor 2015",
      "vendor_id": 71,
      "terms": "",
      "date_added": "2016-01-13T12:27:43.05",
      "added_by": "Mike",
      "date_modified": "2018-08-16T14:13:10.15",
      "modified_by": "Nancy"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "format": "int32",
      "type": "integer",
      "x-ms-summary": "Count"
    },
    "value": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "purchase_order_id": {
            "format": "int32",
            "description": "The purchsae order's identifier.",
            "type": "integer",
            "x-ms-summary": "Purchase order id"
          },
          "order_number": {
            "format": "int64",
            "description": "The order number of the purchase order.",
            "type": "integer",
            "x-ms-summary": "Order number"
          },
          "order_date": {
            "format": "date-time",
            "description": "The date of the purchase order.",
            "type": "string",
            "x-ms-summary": "Order date"
          },
          "type": {
            "description": "The type of the purchase order.",
            "enum": [
              "Template",
              "Blanket",
              "Regular"
            ],
            "type": "string",
            "x-ms-summary": "Type"
          },
          "order_total": {
            "format": "double",
            "description": "The total of the purchase order.",
            "type": "number",
            "x-ms-summary": "Order total"
          },
          "receipted_total": {
            "format": "double",
            "description": "The receipted total of the purchase order.",
            "type": "number",
            "x-ms-summary": "Receipted total"
          },
          "order_status": {
            "description": "The status of the purchase order.",
            "enum": [
              "UnprintedPurchaseOrder",
              "OpenPurchaseOrder",
              "UprintedChangeOrder",
              "ReprintOrder",
              "CanceledOrder",
              "UnprintedCancellationNotice",
              "ClosedOrder",
              "DeletedOrder"
            ],
            "type": "string",
            "x-ms-summary": "Order status"
          },
          "vendor_name": {
            "description": "The vendor name assocaited with the purchase order.",
            "type": "string",
            "x-ms-summary": "Vendor name"
          },
          "vendor_id": {
            "format": "int32",
            "description": "The vendor id of the purchase order.",
            "type": "integer",
            "x-ms-summary": "Vendor id"
          },
          "terms": {
            "description": "The term of the purchase order.",
            "type": "string",
            "x-ms-summary": "Terms"
          },
          "date_added": {
            "format": "date-time",
            "description": "The created date of the purchase order.",
            "type": "string",
            "x-ms-summary": "Date added"
          },
          "added_by": {
            "description": "The creator of the purchase order.",
            "type": "string",
            "x-ms-summary": "Added by"
          },
          "date_modified": {
            "format": "date-time",
            "description": "The modified date of the purchase order.",
            "type": "string",
            "x-ms-summary": "Date modified"
          },
          "modified_by": {
            "description": "The modifier of the purchase order.",
            "type": "string",
            "x-ms-summary": "Modified by"
          }
        },
        "x-display-name": "Purchase order summary",
        "x-ms-summary": "Purchase order summary"
      },
      "x-ms-summary": "Value"
    }
  },
  "x-hidden": true,
  "x-display-name": "Api collection `1",
  "x-ms-summary": "Api collection `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 view purchase orders.

{
  "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/accountspayable/v1/purchaseorders?offset={integer}&limit={integer}&search_text={string}&type={string}&from_date={string}&to_date={string}"
-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}");

            // Request parameters
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["search_text"] = "{string}";
            queryString["type"] = "{string}";
            queryString["from_date"] = "{string}";
            queryString["to_date"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/accountspayable/v1/purchaseorders?" + 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/accountspayable/v1/purchaseorders");

            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("search_text", "{string}");
            builder.setParameter("type", "{string}");
            builder.setParameter("from_date", "{string}");
            builder.setParameter("to_date", "{string}");

            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
            "offset": "{integer}",
            "limit": "{integer}",
            "search_text": "{string}",
            "type": "{string}",
            "from_date": "{string}",
            "to_date": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/accountspayable/v1/purchaseorders?" + $.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/accountspayable/v1/purchaseorders";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"search_text={string}",
                         @"type={string}",
                         @"from_date={string}",
                         @"to_date={string}",
                      ];

    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/accountspayable/v1/purchaseorders');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'offset' => '{integer}',
    'limit' => '{integer}',
    'search_text' => '{string}',
    'type' => '{string}',
    'from_date' => '{string}',
    'to_date' => '{string}',
);

$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({
    # Request parameters
    'offset': '{integer}',
    'limit': '{integer}',
    'search_text': '{string}',
    'type': '{string}',
    'from_date': '{string}',
    'to_date': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/accountspayable/v1/purchaseorders?%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({
    # Request parameters
    'offset': '{integer}',
    'limit': '{integer}',
    'search_text': '{string}',
    'type': '{string}',
    'from_date': '{string}',
    'to_date': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/accountspayable/v1/purchaseorders?%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/purchaseorders')

query = URI.encode_www_form({
    # Request parameters
    'offset' => '{integer}',
    'limit' => '{integer}',
    'search_text' => '{string}',
    'type' => '{string}',
    'from_date' => '{string}',
    'to_date' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end
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 API team? Please visit us on the SKY API Community!