Accounts Payable
This API is used to manage accounts payable, including vendors and invoices.
GET
Invoice adjustment
Returns invoice adjustment information for a specific adjustment. Contains distribution information.
Try itRequest URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| invoice_id | Property is required | integer | The identifier for the invoice to retrieve the adjustment. |
| adjustment_id | Property is required | integer | The identifier for the adjustment to retrieve. Providing an adjustment id of 0 will return the invoice's original distributions. |
| invoiceId | integer | Format - int32. |
|
| adjustmentId | integer | Format - int32. |
|
| 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. |
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 successfully edits the invoice. The response body contains the invoice id.
{
"adjustment_distributions": {
"count": 4,
"value": [
{
"distribution_id": 200645,
"distribution_splits": [
{
"distribution_split_id": 225423,
"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": "2013 Gala Event",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 300.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 300.0,
"description": "Different",
"account_number": "01-5000-00",
"type_code": "Debit",
"custom_fields": []
},
{
"distribution_id": 200646,
"distribution_splits": [
{
"distribution_split_id": 225424,
"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": "2013 Gala Event",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 300.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 300.0,
"description": "",
"account_number": "01-2000-00",
"type_code": "Credit",
"custom_fields": []
},
{
"distribution_id": 200641,
"distribution_splits": [
{
"distribution_split_id": 225418,
"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": "2013 Gala Event",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 200.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 200.0,
"description": "",
"account_number": "01-2000-00",
"type_code": "Debit",
"custom_fields": []
},
{
"distribution_id": 200642,
"distribution_splits": [
{
"distribution_split_id": 225420,
"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": "2013 Gala Event",
"id": 4,
"inactive": false
},
{
"name": "",
"value": "",
"id": 0,
"inactive": false
}
],
"amount": 200.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 200.0,
"description": "sample string",
"account_number": "01-5000-00",
"type_code": "Credit",
"custom_fields": []
}
]
},
"adjustment_id": 118,
"post_status": "Posted",
"post_date": "2019-01-30T00:00:00Z",
"adjustment_date": "2019-01-30T00:00:00Z",
"reason": "My adjustment reason",
"notes": "Notes"
}{
"type": "object",
"properties": {
"adjustment_distributions": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"value": {
"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."
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Collection Response"
},
"adjustment_id": {
"type": "integer",
"description": "The identifier for the invoice adjustment.",
"format": "int32"
},
"post_status": {
"title": "InvoicePostStatus",
"enum": [
"DoNotPost",
"NotYetPosted",
"Posted"
],
"type": "string",
"description": "The post status for the invoice adjustment."
},
"post_date": {
"type": "string",
"description": "The post date for the invoice adjustment.",
"format": "date-time",
"nullable": true
},
"adjustment_date": {
"type": "string",
"description": "The adjustment date for the invoice adjustment.",
"format": "date-time",
"nullable": true
},
"reason": {
"type": "string",
"description": "The reason for the invoice adjustment.",
"nullable": true
},
"notes": {
"type": "string",
"description": "The notes for the invoice adjustment.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contract for invoice adjustment"
}Response 400 Bad Request
Returned when the specified invoice ID in the request URL body or the specified request parameters are not in the appropriate format, or the specified invoice is already posted.
{
"Error": "Failed to save {record}",
"Details": [
"The total percent distributed must equal 100%."
]
}{
"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 invoice adjustments.
{
"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 the specified invoice is not found.
{
"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/{invoice_id}/adjustments/{adjustment_id}?invoiceId={integer}&adjustmentId={integer}&offset={integer}&limit={integer}"
-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["invoiceId"] = "{integer}";
queryString["adjustmentId"] = "{integer}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
var uri = "https://api.sky.blackbaud.com/accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_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/invoices/{invoice_id}/adjustments/{adjustment_id}");
builder.setParameter("invoiceId", "{integer}");
builder.setParameter("adjustmentId", "{integer}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
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
"invoiceId": "{integer}",
"adjustmentId": "{integer}",
"offset": "{integer}",
"limit": "{integer}",
};
$.ajax({
url: "https://api.sky.blackbaud.com/accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_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/invoices/{invoice_id}/adjustments/{adjustment_id}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"invoiceId={integer}",
@"adjustmentId={integer}",
@"offset={integer}",
@"limit={integer}",
];
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/{invoice_id}/adjustments/{adjustment_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
'invoiceId' => '{integer}',
'adjustmentId' => '{integer}',
'offset' => '{integer}',
'limit' => '{integer}',
);
$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
'invoiceId': '{integer}',
'adjustmentId': '{integer}',
'offset': '{integer}',
'limit': '{integer}',
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_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({
# Request parameters
'invoiceId': '{integer}',
'adjustmentId': '{integer}',
'offset': '{integer}',
'limit': '{integer}',
})
try:
conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
conn.request("GET", "/accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_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/invoices/{invoice_id}/adjustments/{adjustment_id}')
query = URI.encode_www_form({
# Request parameters
'invoiceId' => '{integer}',
'adjustmentId' => '{integer}',
'offset' => '{integer}',
'limit' => '{integer}'
})
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