Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Attaches one or more documents to a bill.
Note that this endpoint will return 200 OK as the response. Be sure to check the response body for the response for each document that was sent.
Attach a single document, passing the file contents as binary content in the body.
POST /5af6572c-9771-4b86-995d-3374d3bc683c/bills/b581a643-10dd-4d09-9a63-356654339795/attachments?filename=file.pdf
Attach up to 3 documents using a MIME multipart request.
POST /5af6572c-9771-4b86-995d-3374d3bc683c/bills/b581a643-10dd-4d09-9a63-356654339795/attachments
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
-
string
Format - guid. The bill's id.
-
(optional)string
The name of the file when passing a single document in the body of the request.
Request headers
Request body
Responses
200 OK
A list of document attachment responses.
Representations
{
"list": [
{
"fileName": "file.pdf",
"code": 201,
"error": "The document could not be attached.",
"id": "9c9c4ad0-df3c-4790-970a-5ee1cba3076f",
"url": "(The full URL to download the document.)"
}
]
}
{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "The name of the document.",
"nullable": true,
"example": "file.pdf"
},
"code": {
"type": "integer",
"description": "The HTTP status code for this particular document.",
"format": "int32",
"example": 201
},
"error": {
"type": "string",
"description": "The error message if a document could not be attached.",
"nullable": true,
"example": "The document could not be attached."
},
"id": {
"type": "string",
"description": "The attached document's id.",
"format": "guid",
"nullable": true,
"example": "9c9c4ad0-df3c-4790-970a-5ee1cba3076f"
},
"url": {
"type": "string",
"description": "The URL to retrieve the document.",
"nullable": true,
"example": "(The full URL to download the document.)"
}
},
"additionalProperties": false,
"description": "A response that contains the outcome of a document attachment request."
},
"description": "The list of responses for each document in the request.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A list of document attachment responses."
}
400 Bad Request
The document could not be added as the request contains invalid data.
Representations
{
"message": "Something went wrong.",
"code": 400,
"errorCode": "General.NotFound",
"errors": [
{
"location": "password",
"message": "The value entered is not a valid password.",
"errorCode": "General.DuplicateValue"
}
]
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Something went wrong."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 400
},
"errorCode": {
"type": "string",
"description": "The error code.",
"nullable": true,
"example": "General.NotFound"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The location/path of the source of the error.",
"nullable": true,
"example": "password"
},
"message": {
"type": "string",
"description": "The description of what was wrong at this location.",
"nullable": true,
"example": "The value entered is not a valid password."
},
"errorCode": {
"type": "string",
"description": "The error code.",
"nullable": true,
"example": "General.DuplicateValue"
}
},
"additionalProperties": false,
"description": "Details of a specific error."
},
"description": "An array of specific errors where relevant.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response sent when an error occurs."
}
401 Unauthorized
The authentication token is missing, expired or invalid.
Representations
{
"message": "Authorization has been denied for this request.",
"code": 401
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Authorization has been denied for this request."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 401
}
},
"additionalProperties": false,
"description": "Response sent when a 401 Unauthorized error occurs."
}
403 Forbidden
The user does not have permission to add documents to bills.
Representations
{
"message": "User does not have permission to access this resource.",
"code": 403
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "User does not have permission to access this resource."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 403
}
},
"additionalProperties": false,
"description": "Response sent when a 403 Forbidden error occurs."
}
404 Not Found
The specified book or bill does not exist.
Representations
{
"message": "Resource not found.",
"code": 404
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Resource not found."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 404
}
},
"additionalProperties": false,
"description": "Response sent when a 404 Forbidden error occurs."
}
Code samples
@ECHO OFF
curl -v -X POST "https://api.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments?fileName={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--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("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["fileName"] = "{string}";
var uri = "https://api.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments?" + 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.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments");
builder.setParameter("fileName", "{string}");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// 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
"fileName": "{string}",
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
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.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments";
NSArray* array = @[
// Request parameters
@"entities=true",
@"fileName={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// 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 Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'fileName' => '{string}',
);
$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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'fileName': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("POST", "/r1/v2/{bookId}/bills/{billId}/attachments?%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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'fileName': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("POST", "/r1/v2/{bookId}/bills/{billId}/attachments?%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.reckon.com/r1/v2/{bookId}/bills/{billId}/attachments')
query = URI.encode_www_form({
# Request parameters
'fileName' => '{string}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# 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