Accounts Payable
This API is used to manage accounts payable, including vendors and invoices.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| offset | integer | Represents the number of records to skip. For use with pagination. |
|
| limit | integer | Represents the number of records to return. The default is 100. The maximum allowed value is 500. |
|
| to_date | string | Filter for invoices before a certain date. |
|
| from_date | string | Filter for invoices after a certain date. |
|
| invoice_status | string | Filter by the status of the invoice. |
|
| vendor_name | string | Filter by vendor name. |
|
| last_modified | string | Represents a filter for results modified on or after the specified date. |
|
| date_added | string | Represents a filter for results added on or after the specified date. |
|
| added_by | string | Filter by added by. |
|
| last_modified_by | string | Filter by modified by. |
|
| payment_method | string | Filter by payment method. |
|
| post_status | string | Filter by invoice post status. |
|
| search_text | string | Text to match. Can match vendor_name, invoice_number, description, or purchase_order_number. |
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. |
Response 200 OK
Returned when the operation is successful. The response body contains the list of invoices.
{
"count": 114972,
"value": [
{
"invoice_id": 115570,
"invoice_number": "1234",
"invoice_date": "2018-06-19T00:00:00Z",
"vendor_id": 136,
"vendor_name": "Demo Vendor",
"vendor_status": "Active",
"amount": 22.0,
"description": "Demo Vendor 1",
"status": "Pending",
"post_status": "NotYetPosted",
"balance": 22.0,
"is_past_due": true,
"amount_due": 22.0,
"age": "Current",
"date_added": "2018-06-19T09:57:05.36Z",
"date_modified": "2018-06-19T09:58:07.047Z",
"added_by": "User5",
"modified_by": "User5",
"payment_method": "Check",
"purchase_order_number": "4325"
},
{
"invoice_id": 115571,
"invoice_number": "1234",
"invoice_date": "2018-06-19T00:00:00Z",
"vendor_id": 137,
"vendor_name": "Rowe Cheese Company",
"vendor_status": "Active",
"amount": 900.0,
"description": "Bleu Cheese",
"status": "Pending",
"post_status": "NotYetPosted",
"balance": 900.0,
"is_past_due": true,
"amount_due": 900.0,
"age": "Current",
"date_added": "2018-06-19T10:08:49.46Z",
"date_modified": "2018-06-19T10:09:15.587Z",
"added_by": "User5",
"modified_by": "User5",
"payment_method": "Check",
"purchase_order_number": ""
},
{
"invoice_id": 115569,
"invoice_number": "5886",
"invoice_date": "2018-05-11T00:00:00Z",
"vendor_id": 132,
"vendor_name": "A New Vendor For Post Test1",
"vendor_status": "Active",
"amount": 1070.0,
"description": "post not deleted",
"status": "Approved",
"post_status": "NotYetPosted",
"balance": 1070.0,
"is_past_due": true,
"amount_due": 1070.0,
"age": "31-60 days",
"date_added": "2018-05-11T13:00:28.517Z",
"date_modified": "2018-06-01T11:20:52.897Z",
"added_by": "User2",
"modified_by": "Doug Scott",
"payment_method": "Check",
"purchase_order_number": ""
}
]
}{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"description": "The invoice identifier.",
"format": "int32"
},
"invoice_number": {
"type": "string",
"description": "The number for the invoice.",
"nullable": true
},
"invoice_date": {
"type": "string",
"description": "The date for the invoice.",
"format": "date-time",
"nullable": true
},
"vendor_id": {
"type": "integer",
"description": "The vendor associated with the invoice.",
"format": "int32"
},
"vendor_name": {
"type": "string",
"description": "The name of the vendor for this invoice.",
"nullable": true
},
"vendor_status": {
"title": "VendorStatus",
"enum": [
"Active",
"Inactive",
"OnHold"
],
"type": "string",
"description": "The status of the vendor for this invoice."
},
"amount": {
"type": "number",
"description": "The amount of the invoice.",
"format": "decimal",
"nullable": true
},
"description": {
"type": "string",
"description": "The description for the invoice .",
"nullable": true
},
"status": {
"title": "ApprovalStatus",
"enum": [
"Pending",
"Approved",
"Deleted",
"Paid",
"PartiallyPaid"
],
"type": "string",
"description": "The approval status of this invoice."
},
"post_status": {
"title": "InvoicePostStatus",
"enum": [
"DoNotPost",
"NotYetPosted",
"Posted"
],
"type": "string",
"description": "the post status of this invoice."
},
"balance": {
"type": "number",
"description": "The current balance on this invoice.",
"format": "decimal",
"nullable": true
},
"is_past_due": {
"type": "boolean",
"description": "If the invoice is past due."
},
"amount_due": {
"type": "number",
"description": "The amount still due on the invoice.",
"format": "decimal",
"nullable": true
},
"age": {
"type": "string",
"description": "The age of the invoice.",
"nullable": true
},
"date_added": {
"type": "string",
"description": "The created date of the invoice.",
"format": "date-time",
"nullable": true
},
"date_modified": {
"type": "string",
"description": "The modified date of the invoice.",
"format": "date-time",
"nullable": true
},
"added_by": {
"type": "string",
"description": "The creator of the invoice.",
"nullable": true
},
"modified_by": {
"type": "string",
"description": "The modifier of the invoice.",
"nullable": true
},
"payment_method": {
"title": "PaymentMethod",
"enum": [
"Check",
"EFT",
"BankDraft",
"CreditCard"
],
"type": "string",
"description": "The payment method of the invoice."
},
"purchase_order_number": {
"type": "string",
"description": "The purchase order number for the invoice.",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Collection Response"
}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."
]
}{
"type": "object",
"properties": {
"Error": {
"type": "string",
"nullable": true
},
"Details": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ErrorPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}Response 403 Forbidden
Returned when the user does not have permission to view invoices.
{
"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",
"nullable": true
}
},
"additionalProperties": false
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/accountspayable/v1/invoices?offset={integer}&limit={integer}&to_date={string}&from_date={string}&invoice_status={string}&vendor_name={string}&last_modified={string}&date_added={string}&added_by={string}&last_modified_by={string}&payment_method={string}&post_status={string}&search_text={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["to_date"] = "{string}";
queryString["from_date"] = "{string}";
queryString["invoice_status"] = "{string}";
queryString["vendor_name"] = "{string}";
queryString["last_modified"] = "{string}";
queryString["date_added"] = "{string}";
queryString["added_by"] = "{string}";
queryString["last_modified_by"] = "{string}";
queryString["payment_method"] = "{string}";
queryString["post_status"] = "{string}";
queryString["search_text"] = "{string}";
var uri = "https://api.sky.blackbaud.com/accountspayable/v1/invoices?" + 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/invoices");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("to_date", "{string}");
builder.setParameter("from_date", "{string}");
builder.setParameter("invoice_status", "{string}");
builder.setParameter("vendor_name", "{string}");
builder.setParameter("last_modified", "{string}");
builder.setParameter("date_added", "{string}");
builder.setParameter("added_by", "{string}");
builder.setParameter("last_modified_by", "{string}");
builder.setParameter("payment_method", "{string}");
builder.setParameter("post_status", "{string}");
builder.setParameter("search_text", "{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}",
"to_date": "{string}",
"from_date": "{string}",
"invoice_status": "{string}",
"vendor_name": "{string}",
"last_modified": "{string}",
"date_added": "{string}",
"added_by": "{string}",
"last_modified_by": "{string}",
"payment_method": "{string}",
"post_status": "{string}",
"search_text": "{string}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/accountspayable/v1/invoices?" + $.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/invoices";
NSArray* array = @[
// Request parameters
@"entities=true",
@"offset={integer}",
@"limit={integer}",
@"to_date={string}",
@"from_date={string}",
@"invoice_status={string}",
@"vendor_name={string}",
@"last_modified={string}",
@"date_added={string}",
@"added_by={string}",
@"last_modified_by={string}",
@"payment_method={string}",
@"post_status={string}",
@"search_text={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/invoices');
$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}',
'to_date' => '{string}',
'from_date' => '{string}',
'invoice_status' => '{string}',
'vendor_name' => '{string}',
'last_modified' => '{string}',
'date_added' => '{string}',
'added_by' => '{string}',
'last_modified_by' => '{string}',
'payment_method' => '{string}',
'post_status' => '{string}',
'search_text' => '{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}',
'to_date': '{string}',
'from_date': '{string}',
'invoice_status': '{string}',
'vendor_name': '{string}',
'last_modified': '{string}',
'date_added': '{string}',
'added_by': '{string}',
'last_modified_by': '{string}',
'payment_method': '{string}',
'post_status': '{string}',
'search_text': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/invoices?%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}',
'to_date': '{string}',
'from_date': '{string}',
'invoice_status': '{string}',
'vendor_name': '{string}',
'last_modified': '{string}',
'date_added': '{string}',
'added_by': '{string}',
'last_modified_by': '{string}',
'payment_method': '{string}',
'post_status': '{string}',
'search_text': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/invoices?%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/invoices')
query = URI.encode_www_form({
# Request parameters
'offset' => '{integer}',
'limit' => '{integer}',
'to_date' => '{string}',
'from_date' => '{string}',
'invoice_status' => '{string}',
'vendor_name' => '{string}',
'last_modified' => '{string}',
'date_added' => '{string}',
'added_by' => '{string}',
'last_modified_by' => '{string}',
'payment_method' => '{string}',
'post_status' => '{string}',
'search_text' => '{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