Accounts Payable
This API is used to manage accounts payable, including vendors and invoices.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| vendor_id | Property is required | integer | The identifier of the vendor to get the credit memos. |
| limit | integer | Represents the number of records to return. The default is 100. The maximum allowed value is 500. |
|
| offset | integer | Represents the number of records to skip. For use with pagination. |
|
| post_status | string | Filter by credit memo post status. |
|
| status | string | Filter by credit memo status. |
|
| from_date | string | Represents a filter for results added on or after the specified date. |
|
| to_date | string | Represents a filter for results added on or after the specified date. |
|
| from_post_date | string | Represents a filter for results posted on or after the specified date. |
|
| to_post_date | string | Represents a filter for results posted on or after the specified date. |
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 specified vendor entity's credit memos.
{
"count": 2,
"value": [
{
"credit_memo_id": 183,
"date": "2017-08-31T00:00:00Z",
"description": "my description",
"status": "Applied",
"amount": 150.0,
"balance": 0.0,
"number": "545464",
"post_status": "NotYetPosted",
"post_date": "2017-08-31T00:00:00Z",
"invoice_applications": [
{
"invoice_number": "9712009",
"invoice_date": "2019-01-25T00:00:00Z",
"credit_memo_amount_applied": 50.0,
"invoice_id": 4561
},
{
"invoice_number": "9712008",
"invoice_date": "2019-01-19T00:00:00Z",
"credit_memo_amount_applied": 100.0,
"invoice_id": 185973
}
],
"date_added": "2017-08-31T12:57:58.75Z",
"date_modified": "2019-03-20T15:01:52.393Z",
"added_by": "BentonAu",
"modified_by": "Supervisor"
},
{
"credit_memo_id": 184,
"date": "2017-08-31T00:00:00Z",
"description": "my description",
"status": "Applied",
"amount": 150.0,
"balance": 0.0,
"number": "545464",
"post_status": "NotYetPosted",
"post_date": "2017-08-31T00:00:00Z",
"invoice_applications": [
{
"invoice_number": "9712006",
"invoice_date": "2019-01-25T00:00:00Z",
"credit_memo_amount_applied": 50.0,
"invoice_id": 4563
},
{
"invoice_number": "9712009",
"invoice_date": "2019-01-19T00:00:00Z",
"credit_memo_amount_applied": 100.0,
"invoice_id": 4891
}
],
"date_added": "2017-09-01T12:57:58.75Z",
"date_modified": "2019-03-20T15:01:52.393Z",
"added_by": "BentonAu",
"modified_by": "Supervisor"
}
]
}{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"credit_memo_id": {
"type": "integer",
"description": "The identifier of the credit memo.",
"format": "int32"
},
"date": {
"type": "string",
"description": "The date of the credit memo.",
"format": "date-time"
},
"description": {
"type": "string",
"description": "The description of the credit memo.",
"nullable": true
},
"status": {
"title": "CreditMemoStatus",
"enum": [
"Applied",
"Unapplied",
"PartiallyApplied",
"Deleted"
],
"type": "string",
"description": "The status of the credit memo."
},
"amount": {
"type": "number",
"description": "The amount of the credit memo.",
"format": "decimal"
},
"balance": {
"type": "number",
"description": "The remaining balance of the credit memo.",
"format": "decimal"
},
"number": {
"type": "string",
"description": "The user defined number of the credit memo.",
"nullable": true
},
"post_status": {
"title": "PostStatus",
"enum": [
"DoNotPost",
"NotYetPosted",
"Posted"
],
"type": "string",
"description": "The post status of the credit memo."
},
"post_date": {
"type": "string",
"description": "The post date of the credit memo.",
"format": "date-time",
"nullable": true
},
"invoice_applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_number": {
"type": "string",
"description": "The number of this invoice.",
"nullable": true
},
"invoice_date": {
"type": "string",
"description": "The date of this invoice.",
"format": "date-time"
},
"credit_memo_amount_applied": {
"type": "number",
"description": "The credit memo amount applied to this invoice.",
"format": "decimal"
},
"invoice_id": {
"type": "integer",
"description": "The invoice identifier for this application.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"description": "The invoices this credit memo is applied to.",
"nullable": true
},
"date_added": {
"type": "string",
"description": "The created date of the credit memo.",
"format": "date-time",
"nullable": true
},
"date_modified": {
"type": "string",
"description": "The modified date of the credit memo.",
"format": "date-time",
"nullable": true
},
"added_by": {
"type": "string",
"description": "The creator of the credit memo.",
"nullable": true
},
"modified_by": {
"type": "string",
"description": "The modifier of the credit memo.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class for credit memo summary contract"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Collection Response"
}Response 403 Forbidden
Returned when the user does not have permission to view the specified vendor's credit memos.
{
"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
}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",
"nullable": true
}
},
"additionalProperties": false
}Code samples
@ECHO OFF
curl -v -X GET "https://api.sky.blackbaud.com/accountspayable/v1/vendors/{vendor_id}/creditmemos?limit={integer}&offset={integer}&post_status={string}&status={string}&from_date={string}&to_date={string}&from_post_date={string}&to_post_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["limit"] = "{integer}";
queryString["offset"] = "{integer}";
queryString["post_status"] = "{string}";
queryString["status"] = "{string}";
queryString["from_date"] = "{string}";
queryString["to_date"] = "{string}";
queryString["from_post_date"] = "{string}";
queryString["to_post_date"] = "{string}";
var uri = "https://api.sky.blackbaud.com/accountspayable/v1/vendors/{vendor_id}/creditmemos?" + 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/vendors/{vendor_id}/creditmemos");
builder.setParameter("limit", "{integer}");
builder.setParameter("offset", "{integer}");
builder.setParameter("post_status", "{string}");
builder.setParameter("status", "{string}");
builder.setParameter("from_date", "{string}");
builder.setParameter("to_date", "{string}");
builder.setParameter("from_post_date", "{string}");
builder.setParameter("to_post_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
"limit": "{integer}",
"offset": "{integer}",
"post_status": "{string}",
"status": "{string}",
"from_date": "{string}",
"to_date": "{string}",
"from_post_date": "{string}",
"to_post_date": "{string}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/accountspayable/v1/vendors/{vendor_id}/creditmemos?" + $.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/vendors/{vendor_id}/creditmemos";
NSArray* array = @[
// Request parameters
@"entities=true",
@"limit={integer}",
@"offset={integer}",
@"post_status={string}",
@"status={string}",
@"from_date={string}",
@"to_date={string}",
@"from_post_date={string}",
@"to_post_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/vendors/{vendor_id}/creditmemos');
$url = $request->getUrl();
$headers = array(
// Request headers
'Bb-Api-Subscription-Key' => '{subscription key}',
'Authorization' => 'Bearer {access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'limit' => '{integer}',
'offset' => '{integer}',
'post_status' => '{string}',
'status' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'from_post_date' => '{string}',
'to_post_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
'limit': '{integer}',
'offset': '{integer}',
'post_status': '{string}',
'status': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'from_post_date': '{string}',
'to_post_date': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/vendors/{vendor_id}/creditmemos?%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
'limit': '{integer}',
'offset': '{integer}',
'post_status': '{string}',
'status': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'from_post_date': '{string}',
'to_post_date': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/vendors/{vendor_id}/creditmemos?%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}/creditmemos')
query = URI.encode_www_form({
# Request parameters
'limit' => '{integer}',
'offset' => '{integer}',
'post_status' => '{string}',
'status' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'from_post_date' => '{string}',
'to_post_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