Accounts Payable
This API is used to manage accounts payable, including vendors and invoices.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| credit_memo_id | Property is required | integer | The identifier of the credit memo to retrieve. |
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 credit memo.
{
"credit_memo_id": 183,
"vendor_id": 31,
"vendor_name": "A+ Office Supplies",
"date": "2017-08-31T00:00:00Z",
"amount": 150.0,
"credit_applied": 150.0,
"credit_remaining": 0.0,
"credit_memo_number": "8435779966",
"description": "my description",
"status": "Applied",
"post_status": "NotYetPosted",
"post_date": "2017-08-31T00:00:00Z",
"distributions": [
{
"distribution_id": 140738,
"distribution_splits": [
{
"distribution_split_id": 161971,
"ui_project_id": "1100",
"transaction_code_values": [
{
"name": "Grants",
"value": "None",
"id": 1,
"inactive": false
},
{
"name": "Spendable/Non-Spendable",
"value": "Spendable",
"id": 2,
"inactive": false
},
{
"name": "Performance",
"value": "",
"id": 3,
"inactive": false
},
{
"name": "The Raiser's Edge",
"value": "",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 150.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 150.0,
"account_number": "01-5410-00",
"type_code": "Credit",
"custom_fields": []
},
{
"distribution_id": 140739,
"distribution_splits": [
{
"distribution_split_id": 161972,
"ui_project_id": "",
"transaction_code_values": [
{
"name": "Grants",
"value": "None",
"id": 1,
"inactive": false
},
{
"name": "Spendable/Non-Spendable",
"value": "Spendable",
"id": 2,
"inactive": false
},
{
"name": "Performance",
"value": "",
"id": 3,
"inactive": false
},
{
"name": "The Raiser's Edge",
"value": "",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 150.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 150.0,
"account_number": "01-2000-00",
"type_code": "Debit",
"custom_fields": []
}
],
"custom_fields": [],
"invoice_applications": [
{
"invoice_id": 4545,
"invoice_number": "9712009",
"invoice_amount": 100.0,
"invoice_balance": 0.0,
"credit_memo_amount_applied": 100.0,
"post_date": "2019-01-25T00:00:00Z"
},
{
"invoice_id": 4546,
"invoice_number": "9712006",
"invoice_amount": 100.0,
"invoice_balance": 50.0,
"credit_memo_amount_applied": 50.0,
"post_date": "2019-01-25T00:00:00Z"
}
],
"form_1099_box_numbers": [
{
"number": "3 -Other income",
"state": "SC",
"amount": 60.0
}
],
"date_added": "2017-08-31T12:57:58Z",
"date_modified": "2019-01-25T10:29:31Z",
"added_by": "BentonAu",
"modified_by": "Supervisor"
}{
"required": [
"amount"
],
"type": "object",
"properties": {
"credit_memo_id": {
"type": "integer",
"description": "The credit memo identifier.",
"format": "int32"
},
"vendor_id": {
"type": "integer",
"description": "The id of the vendor for this credit memo.",
"format": "int32"
},
"vendor_name": {
"type": "string",
"description": "The name of the vendor for this credit memo.",
"nullable": true
},
"date": {
"type": "string",
"description": "The date for the credit memo.",
"format": "date-time",
"nullable": true
},
"reversal_date": {
"type": "string",
"description": "The reversal date for the credit memo.",
"format": "date-time",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount of this credit memo.",
"format": "decimal"
},
"credit_applied": {
"type": "number",
"description": "The credit amount applied from this credit memo.",
"format": "decimal",
"nullable": true
},
"credit_remaining": {
"type": "number",
"description": "The credit amount remaining from this credit memo.",
"format": "decimal",
"nullable": true
},
"credit_memo_number": {
"type": "string",
"description": "The credit memo number.",
"nullable": true
},
"description": {
"type": "string",
"description": "The description for this credit memo.",
"nullable": true
},
"status": {
"title": "CreditMemoStatus",
"enum": [
"Applied",
"Unapplied",
"PartiallyApplied",
"Deleted"
],
"type": "string",
"description": "The status of this invoice."
},
"post_status": {
"title": "PostStatus",
"enum": [
"DoNotPost",
"NotYetPosted",
"Posted"
],
"type": "string",
"description": "The post status of this credit memo."
},
"post_date": {
"type": "string",
"description": "The post date for this credit memo.",
"format": "date-time",
"nullable": true
},
"distributions": {
"type": "array",
"items": {
"required": [
"distribution_splits"
],
"type": "object",
"properties": {
"distribution_id": {
"type": "integer",
"description": "The distribution identifier.",
"format": "int32"
},
"distribution_splits": {
"type": "array",
"items": {
"required": [
"transaction_code_values"
],
"type": "object",
"properties": {
"distribution_split_id": {
"type": "integer",
"description": "The distribution split identifier.",
"format": "int32"
},
"ui_project_id": {
"type": "string",
"description": "The user-visible identifier of the project.",
"nullable": true
},
"transaction_code_values": {
"type": "array",
"items": {
"required": [
"id",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The transaction code name.",
"nullable": true
},
"value": {
"type": "string",
"description": "The transaction code value."
},
"id": {
"type": "integer",
"description": "The transaction code value id.",
"format": "int32"
},
"inactive": {
"type": "boolean",
"description": "Indicate if record is inactive or not."
}
},
"additionalProperties": false,
"description": "Transaction code value"
},
"description": "The distribution transaction code values."
},
"amount": {
"type": "number",
"description": "The distribution journal entry amount. Only one of Amount or Percent can be specified.",
"format": "decimal",
"nullable": true
},
"percent": {
"type": "number",
"description": "The distribution journal entry amount percentage. Only one of Amount or Percent can be specified.",
"format": "decimal",
"nullable": true
},
"account_class": {
"type": "string",
"description": "The account class for this distribution split.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Journal Entry Distribution."
},
"description": "The distribution split."
},
"amount": {
"type": "number",
"description": "The distribution amount.",
"format": "decimal"
},
"description": {
"type": "string",
"description": "The description for this distribution.",
"nullable": true
},
"account_number": {
"type": "string",
"description": "The account number for this distribution.",
"nullable": true
},
"type_code": {
"title": "DistributionTypeCode",
"enum": [
"Debit",
"Credit"
],
"type": "string",
"description": "The journal entry transaction type (debit or credit)."
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_name": {
"type": "string",
"description": "The name of the custom field.",
"nullable": true
},
"value": {
"type": "string",
"description": "The value of the custom field.",
"nullable": true
},
"comments": {
"type": "string",
"description": "The description of the custom field.",
"nullable": true
},
"type": {
"title": "CustomFieldDataType",
"enum": [
"Text",
"Number",
"DateTime",
"Currency",
"Boolean",
"Table",
"FuzzyDate"
],
"type": "string",
"description": "The type of the custom field."
},
"is_required": {
"type": "boolean",
"description": "Required status of the custom field."
},
"date": {
"type": "string",
"description": "The date on this custom field.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom field definition."
},
"description": "The custom fields of the distribution.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Distribution."
},
"description": "The distributions of this credit memo.",
"nullable": true
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_name": {
"type": "string",
"description": "The name of the custom field.",
"nullable": true
},
"value": {
"type": "string",
"description": "The value of the custom field.",
"nullable": true
},
"comments": {
"type": "string",
"description": "The description of the custom field.",
"nullable": true
},
"type": {
"title": "CustomFieldDataType",
"enum": [
"Text",
"Number",
"DateTime",
"Currency",
"Boolean",
"Table",
"FuzzyDate"
],
"type": "string",
"description": "The type of the custom field."
},
"is_required": {
"type": "boolean",
"description": "Required status of the custom field."
},
"date": {
"type": "string",
"description": "The date on this custom field.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom field definition."
},
"description": "The custom fields on this credit memo.",
"nullable": true
},
"invoice_applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"description": "The invoice identifier for this application.",
"format": "int32"
},
"invoice_number": {
"type": "string",
"description": "The number of this invoice.",
"nullable": true
},
"invoice_amount": {
"type": "number",
"description": "The total amount for this invoice.",
"format": "decimal"
},
"invoice_balance": {
"type": "number",
"description": "The remaining balance of this invoice.",
"format": "decimal"
},
"credit_memo_amount_applied": {
"type": "number",
"description": "The credit memo amount applied to this invoice.",
"format": "decimal"
},
"post_date": {
"type": "string",
"description": "The post date of this invoice application.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"description": "The invoice applications for this credit memo.",
"nullable": true
},
"form_1099_box_numbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The number for the box number.",
"nullable": true
},
"state": {
"type": "string",
"description": "The reporting state for the box number.",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount for the box number.",
"format": "decimal",
"nullable": true
}
},
"additionalProperties": false,
"description": "The contract for invoice box number."
},
"description": "The form 1099 box numbers credit memo.",
"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"
}Response 403 Forbidden
Returned when the user does not have permission to view the specified credit memo.
{
"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 credit memo 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/creditmemos/{credit_memo_id}"
-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/creditmemos/{credit_memo_id}?" + 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/creditmemos/{credit_memo_id}");
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
};
$.ajax({
url: "https://api.sky.blackbaud.com/accountspayable/v1/creditmemos/{credit_memo_id}?" + $.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/creditmemos/{credit_memo_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:@"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/creditmemos/{credit_memo_id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'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_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({
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/creditmemos/{credit_memo_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
'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("GET", "/accountspayable/v1/creditmemos/{credit_memo_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/accountspayable/v1/creditmemos/{credit_memo_id}')
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