Accounts Payable
This API is used to manage accounts payable, including vendors and invoices.
Request URL
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| invoice_id | Property is required | integer | The identifier for the invoice to edit. |
Request headers
| Header | Required | Type | Description |
|---|---|---|---|
| Content-Type | string | Media type of the body sent to the API. | |
| 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. |
Request body
The changes for the invoice.
{
"vendor_id": 1021,
"vendor_name": "New Vendor",
"invoice_number": "8675",
"invoice_date": "2018-06-27T00:00:00Z",
"due_date": "2018-06-27T00:00:00Z",
"amount": 200.0,
"description": "New Description",
"status": "Approved",
"invoice_payment_detail": {
"remit_to": {
"address_id": 7,
"description": "New Address",
"country": "United States",
"city": "Charleston",
"county": "Charleston",
"state": "SC",
"postal": "29492",
"address_line": "123 Fake Street",
"contact_name": "Mike G."
},
"payment_method": "Check",
"paid_from": "Operating Account",
"credit_card_account_id": 0,
"credit_card_id": 0,
"hold_payment": true,
"create_separate_payment": true
},
"post_status": "NotYetPosted",
"post_date": "2018-06-27T00:00:00Z",
"distribute_discounts": true,
"distributions": [
{
"distribution_id": 0,
"distribution_splits": [
{
"distribution_split_id": 0,
"ui_project_id": "1100",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "None",
"id": 1,
"inactive": false
}
],
"amount": 200.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 200.0,
"description": "Distribution description",
"account_number": "01-5000-00",
"type_code": "Debit",
"custom_fields": []
},
{
"distribution_id": 0,
"distribution_splits": [
{
"distribution_split_id": 0,
"ui_project_id": "1100",
"transaction_code_values": [
{
"name": "Jurisdiction",
"value": "None",
"id": 1,
"inactive": false
}
],
"amount": 200.0,
"percent": 100.0,
"account_class": "Unrestricted Net Assets"
}
],
"amount": 200.0,
"description": "Distribution description",
"account_number": "01-2000-00",
"type_code": "Credit",
"custom_fields": []
}
],
"custom_fields": [
{
"field_name": "Invoice Text Attribute",
"value": "SC - South Carolina",
"comments": "Custom field comment",
"type": "Text",
"is_required": true,
"date": "2018-06-27T00:00:00Z"
}
]
}{
"required": [
"amount",
"description",
"due_date",
"invoice_date",
"status"
],
"type": "object",
"properties": {
"vendor_id": {
"type": "integer",
"description": "The vendor associated with the invoice. (Deprecated)",
"format": "int32"
},
"vendor_name": {
"type": "string",
"description": "The name of the vendor for this invoice. (Deprecated)",
"nullable": true
},
"invoice_number": {
"type": "string",
"description": "The number for the invoice.",
"nullable": true
},
"invoice_date": {
"type": "string",
"description": "The date of the invoice.",
"format": "date-time"
},
"due_date": {
"type": "string",
"description": "The due date of the invoice.",
"format": "date-time"
},
"amount": {
"type": "number",
"description": "The amount of the invoice.",
"format": "decimal"
},
"description": {
"type": "string",
"description": "The description for the invoice."
},
"status": {
"title": "ApprovalStatus",
"enum": [
"Pending",
"Approved",
"Deleted",
"Paid",
"PartiallyPaid"
],
"type": "string",
"description": "The approval status of this invoice."
},
"invoice_payment_detail": {
"type": "object",
"properties": {
"remit_to": {
"required": [
"description"
],
"type": "object",
"properties": {
"address_id": {
"type": "integer",
"description": "The address identifier.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description for this address."
},
"country": {
"type": "string",
"description": "The country for the address.",
"nullable": true
},
"city": {
"type": "string",
"description": "The city for the address.",
"nullable": true
},
"county": {
"type": "string",
"description": "The county for the address.",
"nullable": true
},
"state": {
"type": "string",
"description": "The state or province (or suburb in NZ) for the address.",
"nullable": true
},
"postal": {
"type": "string",
"description": "Refers to the Postal Code or ZIP of the address.",
"nullable": true
},
"address_line": {
"type": "string",
"description": "The street for this address.",
"nullable": true
},
"contact_name": {
"type": "string",
"description": "The full name of the contact for this address.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The remit to address"
},
"payment_method": {
"title": "PaymentMethod",
"enum": [
"Check",
"EFT",
"BankDraft",
"CreditCard"
],
"type": "string",
"description": "The payment method."
},
"paid_from": {
"type": "string",
"description": "The bank from which this was paid.",
"nullable": true
},
"credit_card_account_id": {
"type": "integer",
"description": "The identifier of the credit card account from which this was paid.",
"format": "int32"
},
"credit_card_id": {
"type": "integer",
"description": "The identifier of the credit card from which this was paid.",
"format": "int32"
},
"hold_payment": {
"type": "boolean",
"description": "If or not to hold payment on this invoice."
},
"create_separate_payment": {
"type": "boolean",
"description": "If or not to create a separate payment for this invoice."
}
},
"additionalProperties": false
},
"post_status": {
"title": "InvoicePostStatus",
"enum": [
"DoNotPost",
"NotYetPosted",
"Posted"
],
"type": "string",
"description": "The post status of this invoice."
},
"post_date": {
"type": "string",
"description": "The post date for this invoice.",
"format": "date-time",
"nullable": true
},
"distribute_discounts": {
"type": "boolean",
"description": "If to distribute discounts to invoice expense accounts."
},
"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 on this invoice.",
"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 invoice.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contract for editing invoice."
}Response 200 OK
Returned when the operation successfully edits the invoice. The response body contains the invoice id.
{
"record_id": 843
}{
"type": "object",
"properties": {
"record_id": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}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 edit the invoice.
{
"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 PATCH "https://api.sky.blackbaud.com/accountspayable/v1/invoices/{invoice_id}"
-H "Content-Type: application/json"
-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/invoices/{invoice_id}?" + queryString;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
var request = new HttpRequestMessage(new HttpMethod("PATCH"), uri);
request.Content = content;
var response = await client.SendAsync(request);
}
}
}
}// // 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}");
URI uri = builder.build();
HttpPatch request = new HttpPatch(uri);
request.setHeader("Content-Type", "application/json");
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/invoices/{invoice_id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","Bearer {access token}");
},
type: "PATCH",
// 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}";
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:@"PATCH"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'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_PATCH);
// 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
'Content-Type': 'application/json',
'Bb-Api-Subscription-Key': '{subscription key}',
'Authorization': 'Bearer {access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
conn.request("PATCH", "/accountspayable/v1/invoices/{invoice_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
'Content-Type': 'application/json',
'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("PATCH", "/accountspayable/v1/invoices/{invoice_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}')
request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
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