Accounts Payable

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

GET

Vendor (List)

Returns the list of vendors.

Try it

Request URL

Request parameters

Parameter Required Type Description
offset integer

The number of records to skip, for use with pagination.
limit integer

The number of records to return. If not specified, the default is 100.
The maximum allowed value is 500.
vendor_name string

The name of the vendor.
status string

Status of vendor. Active, pending, or on hold.
ui_vendor_id string

The user-visible identifier for the vendor.
customer_number string

The customer number for the vendor.
last_modified string

Represents a filter for results modified on or after the specified date.
date_added string

Represents a filter for results added on or after the specified date.
added_by string

Filter by added by.
last_modified_by string

Filter by modified by.

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 list of vendors.

{
  "count": 133,
  "value": [
    {
      "vendor_id": 1,
      "vendor_name": "ADS Security Systems",
      "balance_due": 5143.0,
      "ui_defined_id": "0002",
      "customer_number": "1321654ADT",
      "vendor_status": "Active",
      "issue_1099s": false,
      "primary_address": {
        "address_id": 7,
        "description": "Local Address",
        "country": "United States",
        "city": "Charleston",
        "state": "SC",
        "postal": "29416",
        "address_line": "4328 Elliot Circle",
        "is_primary": true,
        "is_invoices": false,
        "is_pos": false,
        "is_1099": false,
        "title": "Mr",
        "first_name": "Bill",
        "last_name": "Jones",
        "position": "District Manager",
        "address_contact_methods": [
          {
            "contact_method_id": 1,
            "contact_type": "Business",
            "contact_info": "800-468-8996"
          },
          {
            "contact_method_id": 44,
            "contact_type": "Business",
            "contact_info": "BJones@ADS-SS.com"
          }
        ]
      },
      "payment_method": "Check",
      "payment_defaults": {
        "has_credit_limit": false,
        "credit_limit": 1000.0,
        "payment_terms": "Net 15",
        "account_name": "Operating",
        "payment_method": "Check",
        "payment_option": "OneForAll"
      },
      "date_added": "2002-01-10T10:43:21.19Z",
      "date_modified": "2018-05-09T00:33:51.09Z",
      "added_by": "Supervisor",
      "modified_by": "Spencer Chambers"
    },
    {
      "vendor_id": 2,
      "vendor_name": "AlphaGraphics",
      "balance_due": 120000.0,
      "ui_defined_id": "0003",
      "customer_number": "ag8754",
      "vendor_status": "Active",
      "issue_1099s": false,
      "primary_address": {
        "address_id": 8,
        "description": "Corporate Address",
        "country": "United States",
        "city": "Charleston",
        "state": "SC",
        "postal": "29401",
        "address_line": "1376 Calhoun Street",
        "is_primary": true,
        "is_invoices": false,
        "is_pos": false,
        "is_1099": false,
        "title": "Ms",
        "first_name": "Sue",
        "last_name": "White",
        "position": "Graphic Artist",
        "address_contact_methods": [
          {
            "contact_method_id": 2,
            "contact_type": "Business",
            "contact_info": "800-468-8996"
          }
        ]
      },
      "payment_method": "Check",
      "payment_defaults": {
        "has_credit_limit": false,
        "payment_terms": "Net 15",
        "account_name": "Operating",
        "payment_method": "Check",
        "payment_option": "OneForAll"
      },
      "date_added": "2002-01-10T10:10:47.177Z",
      "date_modified": "2018-01-02T20:00:57.077Z",
      "added_by": "Supervisor",
      "modified_by": "KathrynWilks"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32"
    },
    "value": {
      "type": "array",
      "items": {
        "required": [
          "vendor_name"
        ],
        "type": "object",
        "properties": {
          "vendor_id": {
            "type": "integer",
            "description": "Vendor identifier.",
            "format": "int32"
          },
          "vendor_name": {
            "type": "string",
            "description": "The name of the vendor."
          },
          "balance_due": {
            "type": "number",
            "description": "The balance due on this vendor.",
            "format": "decimal",
            "nullable": true
          },
          "ui_defined_id": {
            "type": "string",
            "description": "The user-defined identifier of this vendor.",
            "nullable": true
          },
          "customer_number": {
            "type": "string",
            "description": "The customer number.",
            "nullable": true
          },
          "vendor_status": {
            "title": "VendorStatus",
            "enum": [
              "Active",
              "Inactive",
              "OnHold"
            ],
            "type": "string",
            "description": "Status of vendor. \r\nActive, pending, or on hold."
          },
          "issue_1099s": {
            "type": "boolean",
            "description": "If to issue 1099s to this vendor."
          },
          "primary_address": {
            "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/address line for this address.",
                "nullable": true
              },
              "is_primary": {
                "type": "boolean",
                "description": "If this address is the primary address."
              },
              "is_invoices": {
                "type": "boolean",
                "description": "If invoices are sent to this address."
              },
              "is_pos": {
                "type": "boolean",
                "description": "If purchase orders are sent to this address."
              },
              "is_1099": {
                "type": "boolean",
                "description": "If 1099s are sent to this address."
              },
              "title": {
                "type": "string",
                "description": "The title for the primary contact.",
                "nullable": true
              },
              "first_name": {
                "type": "string",
                "description": "The first name of the primary contact.",
                "nullable": true
              },
              "middle_name": {
                "type": "string",
                "description": "The middle initial or name of the primary contact.",
                "nullable": true
              },
              "last_name": {
                "type": "string",
                "description": "The last name of the primary contact.",
                "nullable": true
              },
              "suffix": {
                "type": "string",
                "description": "The suffix of the primary contact.",
                "nullable": true
              },
              "position": {
                "type": "string",
                "description": "The position of the primary contact.",
                "nullable": true
              },
              "address_contact_methods": {
                "type": "array",
                "items": {
                  "required": [
                    "contact_info",
                    "contact_type"
                  ],
                  "type": "object",
                  "properties": {
                    "contact_method_id": {
                      "type": "integer",
                      "description": "The address contact method identifier.",
                      "format": "int32"
                    },
                    "contact_type": {
                      "type": "string",
                      "description": "The type of contact (email, phone, etc)."
                    },
                    "contact_info": {
                      "type": "string",
                      "description": "The contact information (email address, phone number, etc) for this method."
                    }
                  },
                  "additionalProperties": false,
                  "description": "Address information"
                },
                "description": "The list of contact methods for this address.",
                "nullable": true
              }
            },
            "additionalProperties": false,
            "description": "Address information"
          },
          "payment_method": {
            "title": "PaymentMethod",
            "enum": [
              "Check",
              "EFT",
              "BankDraft",
              "CreditCard"
            ],
            "type": "string",
            "description": "The default payment method of this vendor."
          },
          "payment_defaults": {
            "required": [
              "payment_method",
              "payment_option"
            ],
            "type": "object",
            "properties": {
              "has_credit_limit": {
                "type": "boolean",
                "description": "If or not this vendor has as credit limit."
              },
              "credit_limit": {
                "type": "number",
                "description": "The credit limit, if any.",
                "format": "decimal",
                "nullable": true
              },
              "payment_terms": {
                "type": "string",
                "description": "The terms of the payment (NET).",
                "nullable": true
              },
              "account_name": {
                "type": "string",
                "description": "The account from which to pay invoices.",
                "nullable": true
              },
              "payment_method": {
                "title": "PaymentMethod",
                "enum": [
                  "Check",
                  "EFT",
                  "BankDraft",
                  "CreditCard"
                ],
                "type": "string",
                "description": "The payment method."
              },
              "payment_option": {
                "title": "VendorPaymentOption",
                "enum": [
                  "OnePerInvoice",
                  "OneForAll"
                ],
                "type": "string",
                "description": "The payment option."
              }
            },
            "additionalProperties": false,
            "description": "Vendor Information."
          },
          "date_added": {
            "type": "string",
            "description": "The created date of the vendor.",
            "format": "date-time",
            "nullable": true
          },
          "date_modified": {
            "type": "string",
            "description": "The modified date of the vendor.",
            "format": "date-time",
            "nullable": true
          },
          "added_by": {
            "type": "string",
            "description": "The creator of the vendor.",
            "nullable": true
          },
          "modified_by": {
            "type": "string",
            "description": "The modifier of the vendor.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Brief vendor information"
      },
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Collection Response"
}

Response 400 Bad Request

Returned when the request is not in the correct format.

{
  "Error": "Invalid Request",
  "Details": [
    "The value 'fake' is not valid for transaction_status."
  ]
}
{
  "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 vendors.

{
  "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?offset={integer}&limit={integer}&vendor_name={string}&status={string}&ui_vendor_id={string}&customer_number={string}&last_modified={string}&date_added={string}&added_by={string}&last_modified_by={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["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["vendor_name"] = "{string}";
            queryString["status"] = "{string}";
            queryString["ui_vendor_id"] = "{string}";
            queryString["customer_number"] = "{string}";
            queryString["last_modified"] = "{string}";
            queryString["date_added"] = "{string}";
            queryString["added_by"] = "{string}";
            queryString["last_modified_by"] = "{string}";
            var uri = "https://api.sky.blackbaud.com/accountspayable/v1/vendors?" + 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");

            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("vendor_name", "{string}");
            builder.setParameter("status", "{string}");
            builder.setParameter("ui_vendor_id", "{string}");
            builder.setParameter("customer_number", "{string}");
            builder.setParameter("last_modified", "{string}");
            builder.setParameter("date_added", "{string}");
            builder.setParameter("added_by", "{string}");
            builder.setParameter("last_modified_by", "{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
            "offset": "{integer}",
            "limit": "{integer}",
            "vendor_name": "{string}",
            "status": "{string}",
            "ui_vendor_id": "{string}",
            "customer_number": "{string}",
            "last_modified": "{string}",
            "date_added": "{string}",
            "added_by": "{string}",
            "last_modified_by": "{string}",
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/accountspayable/v1/vendors?" + $.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";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"vendor_name={string}",
                         @"status={string}",
                         @"ui_vendor_id={string}",
                         @"customer_number={string}",
                         @"last_modified={string}",
                         @"date_added={string}",
                         @"added_by={string}",
                         @"last_modified_by={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');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'offset' => '{integer}',
    'limit' => '{integer}',
    'vendor_name' => '{string}',
    'status' => '{string}',
    'ui_vendor_id' => '{string}',
    'customer_number' => '{string}',
    'last_modified' => '{string}',
    'date_added' => '{string}',
    'added_by' => '{string}',
    'last_modified_by' => '{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
    'offset': '{integer}',
    'limit': '{integer}',
    'vendor_name': '{string}',
    'status': '{string}',
    'ui_vendor_id': '{string}',
    'customer_number': '{string}',
    'last_modified': '{string}',
    'date_added': '{string}',
    'added_by': '{string}',
    'last_modified_by': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/accountspayable/v1/vendors?%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
    'offset': '{integer}',
    'limit': '{integer}',
    'vendor_name': '{string}',
    'status': '{string}',
    'ui_vendor_id': '{string}',
    'customer_number': '{string}',
    'last_modified': '{string}',
    'date_added': '{string}',
    'added_by': '{string}',
    'last_modified_by': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/accountspayable/v1/vendors?%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')

query = URI.encode_www_form({
    # Request parameters
    'offset' => '{integer}',
    'limit' => '{integer}',
    'vendor_name' => '{string}',
    'status' => '{string}',
    'ui_vendor_id' => '{string}',
    'customer_number' => '{string}',
    'last_modified' => '{string}',
    'date_added' => '{string}',
    'added_by' => '{string}',
    'last_modified_by' => '{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

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