Accounts Payable

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

POST Address

Adds a new vendor address.

Try it

Request URL

Request parameters

vendor_id Property is required integer

The vendor to which we add the address.

Request headers

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 address to be added.

{
  "description": "string",
  "country": "string",
  "city": "string",
  "county": "string",
  "state": "string",
  "address_line": "string",
  "postal": "string",
  "is_primary": true,
  "is_invoices": true,
  "is_pos": true,
  "issue_1099s": true,
  "title": "Mr",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "suffix": "Sr",
  "position": "string",
  "address_contact_methods": [
    {
      "contact_method_id": 0,
      "contact_type": "Business",
      "contact_info": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "description": {
      "description": "The description for this address.",
      "type": "string"
    },
    "country": {
      "description": "The country for the address.",
      "type": "string"
    },
    "city": {
      "description": "The city for the address.",
      "type": "string"
    },
    "county": {
      "description": "The county for this address.",
      "type": "string"
    },
    "state": {
      "description": "The state or province (or suburb in NZ) for the address.",
      "type": "string"
    },
    "address_line": {
      "description": "The street information / address line for this address.",
      "type": "string"
    },
    "postal": {
      "description": "Refers to the Postal Code or ZIP of the address.",
      "type": "string"
    },
    "is_primary": {
      "description": "If this address is the primary address.",
      "type": "boolean"
    },
    "is_invoices": {
      "description": "If invoices are sent to this address.",
      "type": "boolean"
    },
    "is_pos": {
      "description": "If POs are sent to this address.",
      "type": "boolean"
    },
    "issue_1099s": {
      "description": "If 1099s are sent to this address.",
      "type": "boolean"
    },
    "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"
    },
    "first_name": {
      "description": "The first name of the primary contact.",
      "type": "string"
    },
    "middle_name": {
      "description": "The middle initial or name of the primary contact.",
      "type": "string"
    },
    "last_name": {
      "description": "The last name of the primary contact.",
      "type": "string"
    },
    "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"
    },
    "position": {
      "description": "The position of the primary contact.",
      "type": "string"
    },
    "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"
          },
          "contact_type": {
            "description": "The type of contact (email, phone, etc).",
            "enum": [
              "Business",
              "Cell",
              "Emergency",
              "Fax",
              "Home",
              "Pager",
              "WebAddress",
              "Main",
              "Work"
            ],
            "type": "string"
          },
          "contact_info": {
            "description": "The contact information (email address, phone number, etc) for this method.",
            "type": "string"
          }
        },
        "x-display-name": "Address contact method"
      }
    }
  },
  "x-hidden": true,
  "x-display-name": "Create vendor address"
}

Response 200

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

{
  "record_id": 0
}
{
  "type": "object",
  "properties": {
    "record_id": {
      "format": "int32",
      "type": "integer"
    }
  },
  "x-hidden": true,
  "x-display-name": "Created result `1"
}

Response 400

Returned when the request is not in the correct format.

Response 403

Returned when the user does not have permission to create a vendor address.

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/accountspayable/v1/vendors/{vendor_id}/addresses"
-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/vendors/{vendor_id}/addresses?" + queryString;

            HttpResponseMessage response;

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


            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/{vendor_id}/addresses?" + $.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/{vendor_id}/addresses";
    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/{vendor_id}/addresses');
$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/{vendor_id}/addresses?%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/{vendor_id}/addresses?%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/{vendor_id}/addresses')

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