Accounts Payable

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

POST

Vendor

Returns the identifier of the created vendor.

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 vendor to add.

{
  "vendor_name": "Aviato",
  "vendor_type": "Organization",
  "customer_number": "8675309",
  "vendor_status": "Active",
  "issue_1099s": true,
  "address": [
    {
      "address_id": 7,
      "description": "Address description",
      "country": "United States",
      "city": "Charleston",
      "county": "Charleston",
      "state": "SC",
      "postal": "29492",
      "address_line": "123 Fake street",
      "is_primary": true,
      "is_invoices": true,
      "is_pos": true,
      "is_1099": true,
      "title": "Mr",
      "first_name": "Mike",
      "middle_name": "R",
      "last_name": "Giannoni",
      "suffix": "Sr",
      "position": "CEO",
      "address_contact_methods": [
        {
          "contact_method_id": 0,
          "contact_type": "Business",
          "contact_info": "MikeyG@gmail.com"
        }
      ]
    }
  ],
  "vendor_payment_default": {
    "has_credit_limit": true,
    "credit_limit": 200,
    "payment_terms": "Net 15",
    "account_name": "Operating",
    "payment_method": "Check",
    "payment_option": "OnePerInvoice"
  },
  "custom_fields": [
    {
      "field_name": "Solicit for Donations",
      "value": "Yes",
      "comments": "donations comment",
      "date": "2018-06-27T20:26:06.049Z"
    }
  ]
}
{
  "description": "Contract for creating a vendor.",
  "required": [
    "vendor_name"
  ],
  "type": "object",
  "properties": {
    "vendor_name": {
      "description": "Vendor name.",
      "type": "string",
      "x-ms-summary": "Vendor name"
    },
    "vendor_type": {
      "enum": [
        "Organization",
        "Individual"
      ],
      "type": "string",
      "x-ms-summary": "Vendor type"
    },
    "customer_number": {
      "description": "The customer number.",
      "type": "string",
      "x-ms-summary": "Customer number"
    },
    "vendor_status": {
      "description": "Status of vendor. \r\nActive, pending, or on hold.",
      "enum": [
        "Active",
        "Inactive",
        "OnHold"
      ],
      "type": "string",
      "x-ms-summary": "Vendor status"
    },
    "issue_1099s": {
      "description": "If to issue 1099s to this vendor.",
      "type": "boolean",
      "x-ms-summary": "Issue 1099s"
    },
    "address": {
      "description": "The address(es) of the vendor.",
      "type": "array",
      "items": {
        "description": "Address information",
        "required": [
          "description"
        ],
        "type": "object",
        "properties": {
          "address_id": {
            "format": "int32",
            "description": "The address identifier.",
            "type": "integer",
            "x-ms-summary": "Address id"
          },
          "description": {
            "description": "The description for this address.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "country": {
            "description": "The country for the address.",
            "type": "string",
            "x-ms-summary": "Country"
          },
          "city": {
            "description": "The city for the address.",
            "type": "string",
            "x-ms-summary": "City"
          },
          "county": {
            "description": "The county for the address.",
            "type": "string",
            "x-ms-summary": "County"
          },
          "state": {
            "description": "The state or province (or suburb in NZ) for the address.",
            "type": "string",
            "x-ms-summary": "State"
          },
          "postal": {
            "description": "Refers to the Postal Code or ZIP of the address.",
            "type": "string",
            "x-ms-summary": "Postal"
          },
          "address_line": {
            "description": "The street/address line for this address.",
            "type": "string",
            "x-ms-summary": "Address line"
          },
          "is_primary": {
            "description": "If this address is the primary address.",
            "type": "boolean",
            "x-ms-summary": "Is primary"
          },
          "is_invoices": {
            "description": "If invoices are sent to this address.",
            "type": "boolean",
            "x-ms-summary": "Is invoices"
          },
          "is_pos": {
            "description": "If purchase orders are sent to this address.",
            "type": "boolean",
            "x-ms-summary": "Is pos"
          },
          "is_1099": {
            "description": "If 1099s are sent to this address.",
            "type": "boolean",
            "x-ms-summary": "Is 1099"
          },
          "title": {
            "description": "The title for the primary contact.",
            "enum": [
              "Mr",
              "Mrs",
              "Ms",
              "Brother",
              "Captain",
              "Chief",
              "Dr",
              "Drs",
              "Governor",
              "Master",
              "Miss",
              "Pastor",
              "Prof",
              "Rabbi",
              "Rev",
              "TheHonorable",
              "Major"
            ],
            "type": "string",
            "x-ms-summary": "Title"
          },
          "first_name": {
            "description": "The first name of the primary contact.",
            "type": "string",
            "x-ms-summary": "First name"
          },
          "middle_name": {
            "description": "The middle initial or name of the primary contact.",
            "type": "string",
            "x-ms-summary": "Middle name"
          },
          "last_name": {
            "description": "The last name of the primary contact.",
            "type": "string",
            "x-ms-summary": "Last name"
          },
          "suffix": {
            "description": "The suffix of the primary contact.",
            "enum": [
              "Sr",
              "Jr",
              "II",
              "III",
              "IV",
              "Esq",
              "CPA",
              "DDS",
              "DMin",
              "EdD",
              "MD",
              "MEd",
              "OOD",
              "PhD",
              "RN"
            ],
            "type": "string",
            "x-ms-summary": "Suffix"
          },
          "position": {
            "description": "The position of the primary contact.",
            "type": "string",
            "x-ms-summary": "Position"
          },
          "address_contact_methods": {
            "description": "The list of contact methods for this address.",
            "type": "array",
            "items": {
              "description": "Address information",
              "required": [
                "contact_type",
                "contact_info"
              ],
              "type": "object",
              "properties": {
                "contact_method_id": {
                  "format": "int32",
                  "description": "The address contact method identifier.",
                  "type": "integer",
                  "x-ms-summary": "Contact method id"
                },
                "contact_type": {
                  "description": "The type of contact (email, phone, etc).",
                  "enum": [
                    "Business",
                    "Cell",
                    "Emergency",
                    "Fax",
                    "Home",
                    "Pager",
                    "WebAddress",
                    "Main",
                    "Work"
                  ],
                  "type": "string",
                  "x-ms-summary": "Contact type"
                },
                "contact_info": {
                  "description": "The contact information (email address, phone number, etc) for this method.",
                  "type": "string",
                  "x-ms-summary": "Contact info"
                }
              },
              "x-display-name": "Address contact method",
              "x-ms-summary": "Address contact method"
            },
            "x-ms-summary": "Address contact methods"
          }
        },
        "x-display-name": "Vendor address",
        "x-ms-summary": "Vendor address"
      },
      "x-ms-summary": "Address"
    },
    "vendor_payment_default": {
      "description": "The default payment of this vendor.",
      "required": [
        "payment_method",
        "payment_option"
      ],
      "type": "object",
      "properties": {
        "has_credit_limit": {
          "description": "If or not this vendor has as credit limit.",
          "type": "boolean",
          "x-ms-summary": "Has credit limit"
        },
        "credit_limit": {
          "format": "double",
          "description": "The credit limit, if any.",
          "type": "number",
          "x-ms-summary": "Credit limit"
        },
        "payment_terms": {
          "description": "The terms of the payment (NET).",
          "type": "string",
          "x-ms-summary": "Payment terms"
        },
        "account_name": {
          "description": "The account from which to pay invoices.",
          "type": "string",
          "x-ms-summary": "Account name"
        },
        "payment_method": {
          "description": "The payment method.",
          "enum": [
            "Check",
            "EFT",
            "BankDraft",
            "CreditCard"
          ],
          "type": "string",
          "x-ms-summary": "Payment method"
        },
        "payment_option": {
          "description": "The payment option.",
          "enum": [
            "OnePerInvoice",
            "OneForAll"
          ],
          "type": "string",
          "x-ms-summary": "Payment option"
        }
      },
      "x-display-name": "Vendor payment default",
      "x-ms-summary": "Vendor payment default"
    },
    "custom_fields": {
      "description": "The custom fields on this vendor.",
      "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_name": "Aviato",
    "vendor_type": "Organization",
    "customer_number": "8675309",
    "vendor_status": "Active",
    "issue_1099s": true,
    "address": [
      {
        "address_id": 7,
        "description": "Address description",
        "country": "United States",
        "city": "Charleston",
        "county": "Charleston",
        "state": "SC",
        "postal": "29492",
        "address_line": "123 Fake street",
        "is_primary": true,
        "is_invoices": true,
        "is_pos": true,
        "is_1099": true,
        "title": "Mr",
        "first_name": "Mike",
        "middle_name": "R",
        "last_name": "Giannoni",
        "suffix": "Sr",
        "position": "CEO",
        "address_contact_methods": [
          {
            "contact_method_id": 0,
            "contact_type": "Business",
            "contact_info": "MikeyG@gmail.com"
          }
        ]
      }
    ],
    "vendor_payment_default": {
      "has_credit_limit": true,
      "credit_limit": 200,
      "payment_terms": "Net 15",
      "account_name": "Operating",
      "payment_method": "Check",
      "payment_option": "OnePerInvoice"
    },
    "custom_fields": [
      {
        "field_name": "Solicit for Donations",
        "value": "Yes",
        "comments": "donations comment",
        "date": "2018-06-27T20:26:06.049Z"
      }
    ]
  },
  "x-hidden": true,
  "x-display-name": "Create vendor",
  "x-ms-summary": "Create vendor"
}

Response 200 OK

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

{
  "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 a vendor.

{
  "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/vendors"
-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/vendors?" + 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/vendors");


            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/vendors?" + $.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/vendors";
    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/vendors');
$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/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
    '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/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')

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!