Accounts Payable

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

GET

Credit memo

Returns detailed credit memo information.

Try it

Request URL

Request parameters

Parameter Required Type Description
credit_memo_id Property is required integer

The identifier of the credit memo to retrieve.

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, Implicit.

Response 200 OK

Returned when the operation is successful. The response body contains the specified credit memo.

{
  "credit_memo_id": 183,
  "vendor_id": 31,
  "vendor_name": "A+ Office Supplies",
  "date": "2017-08-31T00:00:00",
  "amount": 150,
  "credit_applied": 150,
  "credit_remaining": 0,
  "credit_memo_number": "8435779966",
  "description": "my description",
  "status": "Applied",
  "post_status": "NotYetPosted",
  "post_date": "2017-08-31T00:00:00",
  "distributions": [
    {
      "distribution_id": 140738,
      "distribution_splits": [
        {
          "distribution_split_id": 161971,
          "ui_project_id": "1100",
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable/Non-Spendable",
              "value": "Spendable",
              "id": 2
            },
            {
              "name": "Performance",
              "value": "",
              "id": 3
            },
            {
              "name": "The Raiser's Edge",
              "value": "",
              "id": 4
            },
            {
              "name": "",
              "value": "",
              "id": 0
            }
          ],
          "amount": 150,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ],
      "amount": 150,
      "account_number": "01-5410-00",
      "type_code": "Credit",
      "custom_fields": []
    },
    {
      "distribution_id": 140739,
      "distribution_splits": [
        {
          "distribution_split_id": 161972,
          "ui_project_id": "",
          "transaction_code_values": [
            {
              "name": "Grants",
              "value": "None",
              "id": 1
            },
            {
              "name": "Spendable/Non-Spendable",
              "value": "Spendable",
              "id": 2
            },
            {
              "name": "Performance",
              "value": "",
              "id": 3
            },
            {
              "name": "The Raiser's Edge",
              "value": "",
              "id": 4
            },
            {
              "name": "",
              "value": "",
              "id": 0
            }
          ],
          "amount": 150,
          "percent": 100,
          "account_class": "Unrestricted Net Assets"
        }
      ],
      "amount": 150,
      "account_number": "01-2000-00",
      "type_code": "Debit",
      "custom_fields": []
    }
  ],
  "custom_fields": [],
  "applied_invoice": [
    {
      "invoice_id": 4545,
      "invoice_number": "9712009",
      "invoice_amount": 100,
      "invoice_balance": 0,
      "credit_memo_amount_applied": 100,
      "post_status": "NotYetPosted",
      "post_date": "2019-01-25T00:00:00"
    },
    {
      "invoice_id": 4546,
      "invoice_number": "9712006",
      "invoice_amount": 100,
      "invoice_balance": 50,
      "credit_memo_amount_applied": 50,
      "post_status": "NotYetPosted",
      "post_date": "2019-01-25T00:00:00"
    }
  ],
  "form_1099_box_numbers": [
    {
      "number": "3-Other income",
      "state": "SC",
      "amount": 60
    }
  ],
  "date_added": "2017-08-31T12:57:58",
  "date_modified": "2019-01-25T10:29:31",
  "added_by": "BentonAu",
  "modified_by": "Supervisor"
}
{
  "description": "Class for credit memo summary contract",
  "required": [
    "amount"
  ],
  "type": "object",
  "properties": {
    "credit_memo_id": {
      "format": "int32",
      "description": "The credit memo identifier.",
      "type": "integer",
      "x-ms-summary": "Credit memo id"
    },
    "vendor_id": {
      "format": "int32",
      "description": "The id of the vendor for this credit memo.",
      "type": "integer",
      "x-ms-summary": "Vendor id"
    },
    "vendor_name": {
      "description": "The name of the vendor for this credit memo.",
      "type": "string",
      "x-ms-summary": "Vendor name"
    },
    "date": {
      "format": "date-time",
      "description": "The date for the credit memo.",
      "type": "string",
      "x-ms-summary": "Date"
    },
    "reversal_date": {
      "format": "date-time",
      "description": "The reversal date for the credit memo.",
      "type": "string",
      "x-ms-summary": "Reversal date"
    },
    "amount": {
      "format": "double",
      "description": "The amount of this credit memo.",
      "type": "number",
      "x-ms-summary": "Amount"
    },
    "credit_applied": {
      "format": "double",
      "description": "The credit amount applied from this credit memo.",
      "type": "number",
      "x-ms-summary": "Credit applied"
    },
    "credit_remaining": {
      "format": "double",
      "description": "The credit amount remaining from this credit memo.",
      "type": "number",
      "x-ms-summary": "Credit remaining"
    },
    "credit_memo_number": {
      "description": "The credit memo number.",
      "type": "string",
      "x-ms-summary": "Credit memo number"
    },
    "description": {
      "description": "The description for this credit memo.",
      "type": "string",
      "x-ms-summary": "Description"
    },
    "status": {
      "description": "The status of this invoice.",
      "enum": [
        "Applied",
        "Unapplied",
        "PartiallyApplied",
        "Deleted"
      ],
      "type": "string",
      "x-ms-summary": "Status"
    },
    "post_status": {
      "description": "The post status of this credit memo.",
      "enum": [
        "DoNotPost",
        "NotYetPosted",
        "Posted"
      ],
      "type": "string",
      "x-ms-summary": "Post status"
    },
    "post_date": {
      "format": "date-time",
      "description": "The post date for this credit memo.",
      "type": "string",
      "x-ms-summary": "Post date"
    },
    "distributions": {
      "description": "The distributions of this credit memo.",
      "type": "array",
      "items": {
        "description": "Distribution.",
        "required": [
          "distribution_splits"
        ],
        "type": "object",
        "properties": {
          "distribution_id": {
            "format": "int32",
            "description": "The distribution identifier.",
            "type": "integer",
            "x-ms-summary": "Distribution id"
          },
          "distribution_splits": {
            "description": "The distribution split.",
            "type": "array",
            "items": {
              "description": "Journal Entry Distribution.",
              "required": [
                "transaction_code_values"
              ],
              "type": "object",
              "properties": {
                "distribution_split_id": {
                  "format": "int32",
                  "description": "The distribution split identifier.",
                  "type": "integer",
                  "x-ms-summary": "Distribution split id"
                },
                "ui_project_id": {
                  "description": "The user-visible identifier of the project.",
                  "type": "string",
                  "x-ms-summary": "Ui project id"
                },
                "transaction_code_values": {
                  "description": "The distribution transaction code values.",
                  "type": "array",
                  "items": {
                    "description": "Transaction code value",
                    "required": [
                      "value",
                      "id"
                    ],
                    "type": "object",
                    "properties": {
                      "name": {
                        "description": "The transaction code name.",
                        "type": "string",
                        "x-ms-summary": "Name"
                      },
                      "value": {
                        "description": "The transaction code value.",
                        "type": "string",
                        "x-ms-summary": "Value"
                      },
                      "id": {
                        "format": "int32",
                        "description": "The transaction code value id.",
                        "type": "integer",
                        "x-ms-summary": "Id"
                      }
                    },
                    "x-display-name": "Transaction code value",
                    "x-ms-summary": "Transaction code value"
                  },
                  "x-ms-summary": "Transaction code values"
                },
                "amount": {
                  "format": "double",
                  "description": "The distribution journal entry amount. Only one of Amount or Percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Amount"
                },
                "percent": {
                  "format": "double",
                  "description": "The distribution journal entry amount percentage. Only one of Amount or Percent can be specified.",
                  "type": "number",
                  "x-ms-summary": "Percent"
                },
                "account_class": {
                  "description": "The account class for this distribution split.",
                  "type": "string",
                  "x-ms-summary": "Account class"
                }
              },
              "x-display-name": "Distribution split",
              "x-ms-summary": "Distribution split"
            },
            "x-ms-summary": "Distribution splits"
          },
          "amount": {
            "format": "double",
            "description": "The distribution amount.",
            "type": "number",
            "x-ms-summary": "Amount"
          },
          "description": {
            "description": "The description for this distribution.",
            "type": "string",
            "x-ms-summary": "Description"
          },
          "account_number": {
            "description": "The account number for this distribution.",
            "type": "string",
            "x-ms-summary": "Account number"
          },
          "type_code": {
            "description": "The journal entry transaction type (debit or credit).",
            "enum": [
              "Debit",
              "Credit"
            ],
            "type": "string",
            "x-ms-summary": "Type code"
          },
          "custom_fields": {
            "description": "The custom fields of the distribution.",
            "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"
          }
        },
        "x-display-name": "Distribution",
        "x-ms-summary": "Distribution"
      },
      "x-ms-summary": "Distributions"
    },
    "custom_fields": {
      "description": "The custom fields on this credit memo.",
      "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"
    },
    "invoice_applications": {
      "description": "The invoice applications for this credit memo.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoice_id": {
            "format": "int32",
            "description": "The invoice identifier for this application.",
            "type": "integer",
            "x-ms-summary": "Invoice id"
          },
          "invoice_number": {
            "description": "The number of this invoice.",
            "type": "string",
            "x-ms-summary": "Invoice number"
          },
          "invoice_amount": {
            "format": "double",
            "description": "The total amount for this invoice.",
            "type": "number",
            "x-ms-summary": "Invoice amount"
          },
          "invoice_balance": {
            "format": "double",
            "description": "The remaining balance of this invoice.",
            "type": "number",
            "x-ms-summary": "Invoice balance"
          },
          "credit_memo_amount_applied": {
            "format": "double",
            "description": "The credit memo amount applied to this invoice.",
            "type": "number",
            "x-ms-summary": "Credit memo amount applied"
          },
          "post_date": {
            "format": "date-time",
            "description": "The post date of this invoice application.",
            "type": "string",
            "x-ms-summary": "Post date"
          }
        },
        "x-hidden": true,
        "x-display-name": "Credit memo invoice application detail",
        "x-ms-summary": "Credit memo invoice application detail"
      },
      "x-ms-summary": "Invoice applications"
    },
    "form_1099_box_numbers": {
      "description": "The form 1099 box numbers credit memo.",
      "type": "array",
      "items": {
        "description": "The contract for invoice box number.",
        "type": "object",
        "properties": {
          "number": {
            "description": "The number for the box number.",
            "type": "string",
            "x-ms-summary": "Number"
          },
          "state": {
            "description": "The reporting state for the box number.",
            "type": "string",
            "x-ms-summary": "State"
          },
          "amount": {
            "format": "double",
            "description": "The amount for the box number.",
            "type": "number",
            "x-ms-summary": "Amount"
          }
        },
        "x-display-name": "Invoice box number",
        "x-ms-summary": "Invoice box number"
      },
      "x-ms-summary": "Form 1099box numbers"
    },
    "date_added": {
      "format": "date-time",
      "description": "The created date of the credit memo.",
      "type": "string",
      "x-ms-summary": "Date added"
    },
    "date_modified": {
      "format": "date-time",
      "description": "The modified date of the credit memo.",
      "type": "string",
      "x-ms-summary": "Date modified"
    },
    "added_by": {
      "description": "The creator of the credit memo.",
      "type": "string",
      "x-ms-summary": "Added by"
    },
    "modified_by": {
      "description": "The modifier of the credit memo.",
      "type": "string",
      "x-ms-summary": "Modified by"
    }
  },
  "x-display-name": "Credit memo detail",
  "x-ms-summary": "Credit memo detail"
}

Response 403 Forbidden

Returned when the user does not have permission to view the specified credit memo.

{
  "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 no credit memo is found with the specified ID.

{
  "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 GET "https://api.sky.blackbaud.com/accountspayable/v1/creditmemos/{credit_memo_id}"
-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/creditmemos/{credit_memo_id}?" + 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/creditmemos/{credit_memo_id}");


            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
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/accountspayable/v1/creditmemos/{credit_memo_id}?" + $.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/creditmemos/{credit_memo_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:@"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/creditmemos/{credit_memo_id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
   '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_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({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("GET", "/accountspayable/v1/creditmemos/{credit_memo_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
    '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("GET", "/accountspayable/v1/creditmemos/{credit_memo_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/creditmemos/{credit_memo_id}')

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