Accounts Payable

This API is used to manage accounts payable, including vendors and invoices.

POST

Invoice

Returns the id of the created invoice.

Try it

Request URL

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, Implicit.

Request body

The invoice to create. Note that invoices must have paired distributions where every debit distribution has a matching credit distribution of the same amount.

{
  "vendor_id": 1082,
  "amount": 100,
  "description": "Invoice description",
  "invoice_number": "8675309",
  "approval_status": "Pending",
  "due_date": "2018-06-27T20:26:05.939Z",
  "payment_details": {
    "remit_to": {
      "address_id": 7
    },
    "payment_method": "Check",
    "paid_from": "Benton",
    "hold_payment": true,
    "create_separate_payment": true
  },
  "invoice_date": "2018-06-27T20:26:05.939Z",
  "post_status": "DoNotPost",
  "post_date": "2018-06-27T20:26:05.939Z",
  "distribute_discounts": true,
  "distributions": [
    {
      "distribution_splits": [
        {
          "ui_project_id": "1100",
          "transaction_code_values": [
            {
              "name": "Jurisdiction",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable?",
              "value": "Spendable",
              "id": 2
            }
          ],
          "amount": 100,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ],
      "amount": 100,
      "description": "Debit distribution",
      "account_number": "01-5000-00",
      "type_code": "Debit"
    },
    {
      "distribution_splits": [
        {
          "ui_project_id": "1100",
          "transaction_code_values": [
            {
              "name": "Jurisdiction",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable?",
              "value": "Spendable",
              "id": 2
            }
          ],
          "amount": 100,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ],
      "amount": 100,
      "description": "Credit distribution",
      "account_number": "01-2000-00",
      "type_code": "Credit"
    }
  ],
  "custom_fields": [
    {
      "field_name": "State",
      "value": "SC - South Carolina",
      "comments": "Custom Field Comment",
      "date": "2018-06-27T20:26:05.939Z"
    }
  ]
}
{
  "description": "Contract for creating invoice.",
  "required": [
    "vendor_id",
    "amount",
    "due_date",
    "payment_details",
    "invoice_date",
    "post_date",
    "distributions"
  ],
  "type": "object",
  "properties": {
    "vendor_id": {
      "format": "int32",
      "description": "The id of the vendor for this invoice.",
      "type": "integer",
      "x-ms-summary": "Vendor id"
    },
    "amount": {
      "format": "double",
      "description": "The amount of this invoice.",
      "type": "number",
      "x-ms-summary": "Amount"
    },
    "description": {
      "description": "The description for this invoice.",
      "type": "string",
      "x-ms-summary": "Description"
    },
    "invoice_number": {
      "description": "The invoice number.",
      "maxLength": 2147483647,
      "minLength": 1,
      "type": "string",
      "x-ms-summary": "Invoice number"
    },
    "approval_status": {
      "description": "The approval status of this invoice.",
      "enum": [
        "Pending",
        "Approved",
        "Deleted",
        "Paid",
        "PartiallyPaid"
      ],
      "type": "string",
      "x-ms-summary": "Approval status"
    },
    "due_date": {
      "format": "date-time",
      "description": "The due date for this invoice.",
      "type": "string",
      "x-ms-summary": "Due date"
    },
    "payment_details": {
      "required": [
        "remit_to"
      ],
      "type": "object",
      "properties": {
        "remit_to": {
          "description": "The address to which this invoice will be remitted.",
          "required": [
            "address_id"
          ],
          "type": "object",
          "properties": {
            "address_id": {
              "format": "int32",
              "description": "The address identifier.",
              "type": "integer",
              "x-ms-summary": "Address id"
            }
          },
          "x-display-name": "Remit to address id",
          "x-ms-summary": "Remit to",
          "x-hidden": true
        },
        "payment_method": {
          "description": "The payment method.",
          "enum": [
            "Check",
            "EFT",
            "BankDraft",
            "CreditCard"
          ],
          "type": "string",
          "x-ms-summary": "Payment method"
        },
        "paid_from": {
          "description": "The bank from which this was paid.",
          "type": "string",
          "x-ms-summary": "Paid from"
        },
        "hold_payment": {
          "description": "If or not to hold payment on this invoice.",
          "type": "boolean",
          "x-ms-summary": "Hold payment"
        },
        "create_separate_payment": {
          "description": "If or not to create a separate payment for this invoice.",
          "type": "boolean",
          "x-ms-summary": "Create separate payment"
        }
      },
      "x-hidden": true,
      "x-display-name": "Create invoice payment details",
      "x-ms-summary": "Payment details",
      "description": "The payment details for this invoice."
    },
    "invoice_date": {
      "format": "date-time",
      "description": "The date for the invoice.",
      "type": "string",
      "x-ms-summary": "Invoice date"
    },
    "post_status": {
      "description": "the post status of this invoice.",
      "enum": [
        "DoNotPost",
        "NotYetPosted",
        "Posted"
      ],
      "type": "string",
      "x-ms-summary": "Post status"
    },
    "post_date": {
      "format": "date-time",
      "description": "The post date for this invoice.",
      "type": "string",
      "x-ms-summary": "Post date"
    },
    "distribute_discounts": {
      "description": "If to distribute discounts to invoice expense accounts.",
      "type": "boolean",
      "x-ms-summary": "Distribute discounts"
    },
    "distributions": {
      "description": "The distributions of this invoice.",
      "type": "array",
      "items": {
        "description": "Distribution.",
        "required": [
          "distribution_splits"
        ],
        "type": "object",
        "properties": {
          "distribution_id": {
            "format": "int32",
            "description": "The distribution identifier.",
            "type": "integer",
            "x-ms-summary": "Distribution id"
          },
          "distribution_splits": {
            "description": "The distribution split.",
            "type": "array",
            "items": {
              "description": "Journal Entry Distribution.",
              "required": [
                "transaction_code_values"
              ],
              "type": "object",
              "properties": {
                "distribution_split_id": {
                  "format": "int32",
                  "description": "The distribution split identifier.",
                  "type": "integer",
                  "x-ms-summary": "Distribution split id"
                },
                "ui_project_id": {
                  "description": "The user-visible identifier of the project.",
                  "type": "string",
                  "x-ms-summary": "Ui project id"
                },
                "transaction_code_values": {
                  "description": "The distribution transaction code values.",
                  "type": "array",
                  "items": {
                    "description": "Transaction code value",
                    "required": [
                      "value",
                      "id"
                    ],
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "The transaction code name.",
                        "type": "string",
                        "x-ms-summary": "Name"
                      },
                      "value": {
                        "description": "The transaction code value.",
                        "type": "string",
                        "x-ms-summary": "Value"
                      },
                      "id": {
                        "format": "int32",
                        "description": "The transaction code value id.",
                        "type": "integer",
                        "x-ms-summary": "Id"
                      }
                    },
                    "x-display-name": "Transaction code value",
                    "x-ms-summary": "Transaction code value"
                  },
                  "x-ms-summary": "Transaction code values"
                },
                "amount": {
                  "format": "double",
                  "description": "The distribution journal entry amount. Only one of Amount or Percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Amount"
                },
                "percent": {
                  "format": "double",
                  "description": "The distribution journal entry amount percentage. Only one of Amount or Percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Percent"
                },
                "account_class": {
                  "description": "The account class for this distribution split.",
                  "type": "string",
                  "x-ms-summary": "Account class"
                }
              },
              "x-display-name": "Distribution split",
              "x-ms-summary": "Distribution split"
            },
            "x-ms-summary": "Distribution splits"
          },
          "amount": {
            "format": "double",
            "description": "The distribution amount.",
            "type": "number",
            "x-ms-summary": "Amount"
          },
          "description": {
            "description": "The description for this distribution.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "account_number": {
            "description": "The account number for this distribution.",
            "type": "string",
            "x-ms-summary": "Account number"
          },
          "type_code": {
            "description": "The journal entry transaction type (debit or credit).",
            "enum": [
              "Debit",
              "Credit"
            ],
            "type": "string",
            "x-ms-summary": "Type code"
          }
        },
        "x-display-name": "Distribution",
        "x-ms-summary": "Distribution"
      },
      "x-ms-summary": "Distributions"
    },
    "custom_fields": {
      "description": "The custom fields on this invoice.",
      "type": "array",
      "items": {
        "description": "The create contract for custom fields.",
        "type": "object",
        "properties": {
          "field_name": {
            "description": "The name of the custom field.",
            "type": "string",
            "x-ms-summary": "Field name"
          },
          "value": {
            "description": "The value for this custom field.",
            "type": "string",
            "x-ms-summary": "Value"
          },
          "type": {
            "description": "The type of this custom field.",
            "enum": [
              "Text",
              "Number",
              "DateTime",
              "Currency",
              "Boolean",
              "Table",
              "FuzzyDate"
            ],
            "type": "string",
            "x-ms-summary": "Type"
          },
          "comments": {
            "description": "The description for this custom field.",
            "type": "string",
            "x-ms-summary": "Comments"
          },
          "date": {
            "format": "date-time",
            "description": "The date on this custom field.",
            "type": "string",
            "x-ms-summary": "Date"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create custom field",
        "x-ms-summary": "Create custom field"
      },
      "x-ms-summary": "Custom fields"
    }
  },
  "example": {
    "vendor_id": 1082,
    "amount": 100,
    "description": "Invoice description",
    "invoice_number": "8675309",
    "approval_status": "Pending",
    "due_date": "2018-06-27T20:26:05.939Z",
    "payment_details": {
      "remit_to": {
        "address_id": 7
      },
      "payment_method": "Check",
      "paid_from": "Benton",
      "hold_payment": true,
      "create_separate_payment": true
    },
    "invoice_date": "2018-06-27T20:26:05.939Z",
    "post_status": "DoNotPost",
    "post_date": "2018-06-27T20:26:05.939Z",
    "distribute_discounts": true,
    "distributions": [
      {
        "distribution_splits": [
          {
            "ui_project_id": "1100",
            "transaction_code_values": [
              {
                "name": "Jurisdiction",
                "value": "None",
                "id": 1
              },
              {
                "name": "Spendable?",
                "value": "Spendable",
                "id": 2
              }
            ],
            "amount": 100,
            "percent": 100,
            "account_class": "Unrestricted Net Assets"
          }
        ],
        "amount": 100,
        "description": "Debit distribution",
        "account_number": "01-5000-00",
        "type_code": "Debit"
      },
      {
        "distribution_splits": [
          {
            "ui_project_id": "1100",
            "transaction_code_values": [
              {
                "name": "Jurisdiction",
                "value": "None",
                "id": 1
              },
              {
                "name": "Spendable?",
                "value": "Spendable",
                "id": 2
              }
            ],
            "amount": 100,
            "percent": 100,
            "account_class": "Unrestricted Net Assets"
          }
        ],
        "amount": 100,
        "description": "Credit distribution",
        "account_number": "01-2000-00",
        "type_code": "Credit"
      }
    ],
    "custom_fields": [
      {
        "field_name": "State",
        "value": "SC - South Carolina",
        "comments": "Custom Field Comment",
        "date": "2018-06-27T20:26:05.939Z"
      }
    ]
  },
  "x-display-name": "Create invoice",
  "x-ms-summary": "Create invoice"
}

Response 200 OK

Returned when the operation is successful. The response body contains the ID of the created invoice.

{
  "id": 843
}
{
  "type": "object",
  "properties": {
    "record_id": {
      "format": "int32",
      "type": "integer",
      "x-ms-summary": "Record id"
    }
  },
  "x-hidden": true,
  "x-display-name": "Created result `1",
  "x-ms-summary": "Created result `1"
}

Response 400 Bad Request

Returned when the request is not in the correct format.

{
  "Error": "Failed to save {record}",
  "Details": [
    "The total percent distributed must equal 100%."
  ],
  "ErrorPath": null
}
{
  "type": "object",
  "properties": {
    "Error": {
      "type": "string",
      "x-ms-summary": "Error"
    },
    "Details": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "x-ms-summary": "Details"
    },
    "ErrorPath": {
      "type": "string",
      "x-ms-summary": "Error path"
    }
  },
  "x-display-name": "Domain error message",
  "x-ms-summary": "Domain error message"
}

Response 403 Forbidden

Returned when the user does not have permission to create an 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",
      "x-ms-summary": "Error"
    }
  },
  "x-display-name": "Basic error message",
  "x-ms-summary": "Basic error message"
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/accountspayable/v1/invoices"
-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", "{access token}");

            var uri = "https://api.sky.blackbaud.com/accountspayable/v1/invoices?" + 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 response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // 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");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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?" + $.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: "POST",
            // 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",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // 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');
$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_POST);

// 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("POST", "/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
    '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("POST", "/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')

request = Net::HTTP::Post.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

Have a question? See a problem with our docs? Want to engage with the SKY API team? Please visit us on the SKY API Community!