Accounts Payable

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

POST

Line item

Adds line items to an existing purchase order.

Try it

Request URL

Request parameters

Parameter Required Type Description
purchase_order_id Property is required integer

The identifier of the purchase order on which to create line items.

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.

Request body

Line items to add to the purchase order.

[
  {
    "type": "Regular",
    "product_id": 1,
    "vendor_part_number": "L-1001",
    "description": "Laptop Computer",
    "quantity_ordered": 1.0,
    "unit_of_measure": "Each",
    "unit_cost": 300.0,
    "extended_cost": 300.0,
    "post_status": "NotYetPosted",
    "post_date": "2018-08-30T12:00:00Z",
    "comments": "a comment",
    "notes": "a note",
    "deliver_to": "Alex W",
    "requested_by": "Benton AU",
    "department": "01 Facilities",
    "distributions": [
      {
        "distribution_id": 0,
        "distribution_splits": [
          {
            "distribution_split_id": 0,
            "ui_project_id": "1100",
            "transaction_code_values": [
              {
                "name": "Jurisdiction",
                "value": "None",
                "id": 1,
                "inactive": false
              },
              {
                "name": "Spendable?",
                "value": "Spendable",
                "id": 2,
                "inactive": false
              }
            ],
            "amount": 100.0,
            "percent": 100.0,
            "account_class": "Unrestricted Net Assets"
          }
        ],
        "amount": 100.0,
        "description": "Debit distribution",
        "account_number": "01-5000-00",
        "type_code": "Debit",
        "custom_fields": []
      },
      {
        "distribution_id": 0,
        "distribution_splits": [
          {
            "distribution_split_id": 0,
            "ui_project_id": "1100",
            "transaction_code_values": [
              {
                "name": "Jurisdiction",
                "value": "None",
                "id": 1,
                "inactive": false
              },
              {
                "name": "Spendable ?",
                "value": "Spendable",
                "id": 2,
                "inactive": false
              }
            ],
            "amount": 100.0,
            "percent": 100.0,
            "account_class": "Unrestricted Net Assets"
          }
        ],
        "amount": 100.0,
        "description": "Credit distribution",
        "account_number": "01-2000-00",
        "type_code": "Credit",
        "custom_fields": []
      }
    ],
    "interfund_set": "00"
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "distributions",
      "extended_cost",
      "post_status",
      "product_id",
      "quantity_ordered",
      "type",
      "unit_cost"
    ],
    "type": "object",
    "properties": {
      "type": {
        "title": "LineItemType",
        "enum": [
          "Regular",
          "Miscellaneous",
          "Comment"
        ],
        "type": "string",
        "description": "The type of the line item.\r\nThe accounts Payable API currently only supports creating Regular line items."
      },
      "product_id": {
        "type": "integer",
        "description": "The prodcut identifier of the line item.",
        "format": "int32"
      },
      "vendor_part_number": {
        "type": "string",
        "description": "The vendor part number of the line item.",
        "nullable": true
      },
      "description": {
        "type": "string",
        "description": "The description of the line item.",
        "nullable": true
      },
      "quantity_ordered": {
        "type": "number",
        "description": "The quantity ordered of the line item.",
        "format": "decimal"
      },
      "unit_of_measure": {
        "type": "string",
        "description": "The unit of measure of the line item.",
        "nullable": true
      },
      "unit_cost": {
        "type": "number",
        "description": "The unit of cost of the line item.",
        "format": "decimal"
      },
      "extended_cost": {
        "type": "number",
        "description": "The extended cost of the line item.",
        "format": "decimal"
      },
      "post_status": {
        "title": "PostStatus",
        "enum": [
          "DoNotPost",
          "NotYetPosted",
          "Posted"
        ],
        "type": "string",
        "description": "The post status of the line item."
      },
      "post_date": {
        "type": "string",
        "description": "The post date of the line item.\r\nIs required for line items with the status NotYetPosted",
        "format": "date-time",
        "nullable": true
      },
      "comments": {
        "type": "string",
        "description": "The comments of the line item.",
        "nullable": true
      },
      "notes": {
        "type": "string",
        "description": "The notes of the line item.",
        "nullable": true
      },
      "deliver_to": {
        "type": "string",
        "description": "The staff member to deliver to for the line item.",
        "nullable": true
      },
      "requested_by": {
        "type": "string",
        "description": "The staff member that requested the line item.",
        "nullable": true
      },
      "department": {
        "type": "string",
        "description": "The department of the line item.",
        "nullable": true
      },
      "distributions": {
        "type": "array",
        "items": {
          "required": [
            "distribution_splits"
          ],
          "type": "object",
          "properties": {
            "distribution_id": {
              "type": "integer",
              "description": "The distribution identifier.",
              "format": "int32"
            },
            "distribution_splits": {
              "type": "array",
              "items": {
                "required": [
                  "transaction_code_values"
                ],
                "type": "object",
                "properties": {
                  "distribution_split_id": {
                    "type": "integer",
                    "description": "The distribution split identifier.",
                    "format": "int32"
                  },
                  "ui_project_id": {
                    "type": "string",
                    "description": "The user-visible identifier of the project.",
                    "nullable": true
                  },
                  "transaction_code_values": {
                    "type": "array",
                    "items": {
                      "required": [
                        "id",
                        "value"
                      ],
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "The transaction code name.",
                          "nullable": true
                        },
                        "value": {
                          "type": "string",
                          "description": "The transaction code value."
                        },
                        "id": {
                          "type": "integer",
                          "description": "The transaction code value id.",
                          "format": "int32"
                        },
                        "inactive": {
                          "type": "boolean",
                          "description": "Indicate if record is inactive or not."
                        }
                      },
                      "additionalProperties": false,
                      "description": "Transaction code value"
                    },
                    "description": "The distribution transaction code values. The values should be in the same order as the codes defined in the database."
                  },
                  "amount": {
                    "type": "number",
                    "description": "The distribution journal entry amount. Only one of Amount or Percent can be specified.",
                    "format": "decimal",
                    "nullable": true
                  },
                  "percent": {
                    "type": "number",
                    "description": "The distribution journal entry amount percentage. Only one of Amount or Percent can be specified.",
                    "format": "decimal",
                    "nullable": true
                  },
                  "account_class": {
                    "type": "string",
                    "description": "The account class for this distribution split.",
                    "nullable": true
                  }
                },
                "additionalProperties": false,
                "description": "Journal Entry Distribution."
              },
              "description": "The distribution split."
            },
            "amount": {
              "type": "number",
              "description": "The distribution amount.",
              "format": "decimal"
            },
            "description": {
              "type": "string",
              "description": "The description for this distribution.",
              "nullable": true
            },
            "account_number": {
              "type": "string",
              "description": "The account number for this distribution.",
              "nullable": true
            },
            "type_code": {
              "title": "DistributionTypeCode",
              "enum": [
                "Debit",
                "Credit"
              ],
              "type": "string",
              "description": "The journal entry transaction type (debit or credit)."
            },
            "custom_fields": {
              "type": "array",
              "items": {
                "required": [
                  "field_name",
                  "value"
                ],
                "type": "object",
                "properties": {
                  "field_name": {
                    "type": "string",
                    "description": "The name of the custom field."
                  },
                  "value": {
                    "type": "string",
                    "description": "The value for this custom field."
                  },
                  "comments": {
                    "type": "string",
                    "description": "The description for this custom field.",
                    "nullable": true
                  },
                  "date": {
                    "type": "string",
                    "description": "The date on this custom field.",
                    "format": "date-time",
                    "nullable": true
                  }
                },
                "additionalProperties": false,
                "description": "The create contract for custom fields."
              },
              "description": "The custom fields of the distribution.",
              "nullable": true
            }
          },
          "additionalProperties": false,
          "description": "Contract for creating distribution."
        },
        "description": "The distributions of the line item."
      },
      "interfund_set": {
        "type": "string",
        "description": "The interfund set for this line item's distributions.",
        "nullable": true
      }
    },
    "additionalProperties": false,
    "description": "Line item summary"
  },
  "x-apim-inline": true
}

Response 200 OK

Returned when the operation is successful.

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%."
  ]
}
{
  "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 create an purchase order.

{
  "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 POST "https://api.sky.blackbaud.com/accountspayable/v1/purchaseorders/{purchase_order_id}/lineitems"
-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/purchaseorders/{purchase_order_id}/lineitems?" + 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/purchaseorders/{purchase_order_id}/lineitems");


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

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 Developer team? Please visit us on the SKY Developer Community!