Accounts Payable

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

PATCH

Vendor

Edits a specified vendor.

Try it

Request URL

Request parameters

Parameter Required Type Description
vendor_id Property is required integer

The identifier of the vendor 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, Implicit.

Request body

The changes for the vendor.

{
  "vendor_name": "Aviato",
  "vendor_type": "Organization",
  "customer_number": "8675309",
  "vendor_status": "Active",
  "issue_1099s": true,
  "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 editing a vendor.",
  "type": "object",
  "properties": {
    "vendor_name": {
      "description": "Vendor name.",
      "type": "string",
      "x-ms-summary": "Vendor name"
    },
    "vendor_type": {
      "description": "Type of the Vendor",
      "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"
    },
    "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": "Custom field definition.",
        "type": "object",
        "properties": {
          "field_name": {
            "description": "The name of the custom field.",
            "type": "string",
            "x-ms-summary": "Field name"
          },
          "value": {
            "description": "The value of the custom field.",
            "type": "string",
            "x-ms-summary": "Value"
          },
          "comments": {
            "description": "The description of the custom field.",
            "type": "string",
            "x-ms-summary": "Comments"
          },
          "type": {
            "description": "The type of the custom field.",
            "enum": [
              "Text",
              "Number",
              "DateTime",
              "Currency",
              "Boolean",
              "Table",
              "FuzzyDate"
            ],
            "type": "string",
            "x-ms-summary": "Type"
          },
          "is_required": {
            "description": "Required status of the custom field.",
            "type": "boolean",
            "x-ms-summary": "Is required"
          },
          "date": {
            "format": "date-time",
            "description": "The date on this custom field.",
            "type": "string",
            "x-ms-summary": "Date"
          }
        },
        "x-display-name": "Custom field",
        "x-ms-summary": "Custom field"
      },
      "x-ms-summary": "Custom fields"
    }
  },
  "example": {
    "vendor_name": "Aviato",
    "vendor_type": "Organization",
    "customer_number": "8675309",
    "vendor_status": "Active",
    "issue_1099s": true,
    "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": "Edit vendor",
  "x-ms-summary": "Edit vendor"
}

Response 200 OK

Returned when the operation successfully edits the vendor. The response body contains the vendor identifier.

{
  "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 specified vendor identifier in the request URL body or the specified request parameters are not in the appropriate 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 edit the 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"
}

Response 404 Not Found

Returned when the specified vendor 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",
      "x-ms-summary": "Error"
    }
  },
  "x-display-name": "Basic error message",
  "x-ms-summary": "Basic error message"
}

Code samples

@ECHO OFF

curl -v -X PATCH "https://api.sky.blackbaud.com/accountspayable/v1/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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/vendors/{vendor_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

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!