Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of estimate templates for the specified book.

See here for details of paging, filtering, sorting and selecting.

Get a list of templates of the given type for the specified book.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/templates/estimates

Get a specific page of templates. Find out more about paging.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/templates/estimates?page=2&perpage=10

Get just the required fields, e.g. id and name. Find out more about selecting.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/templates/estimates?select=id,name

Filter the results to return just the templates you want. Find out more about filtering.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/templates/estimates?filter=name eq "Professional Invoice"

Sort in the required order, e.g. by template name and then by font size. Find out more about sorting.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/templates/estimates?orderby=name,fontSize desc

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • (optional)
    integer

    Format - int32. The page to retrieve.

  • (optional)
    integer

    Format - int32. The number of super funds per page.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

A list of estimates templates for the specified book.

Representations

{
  "list": [
    {
      "id": "d45f44de-e37e-4cb6-8685-d2b96e4bf720",
      "name": "Standard Invoice",
      "font": "Open Sans",
      "fontSize": 7.0,
      "header": {
        "companyName": true,
        "companyAddress": true,
        "taxNumber": true,
        "phoneNumber": true,
        "email": true,
        "website": true,
        "logo": {
          "name": "giant800px-Coca-Cola_logo.svg.png",
          "url": "\"url\": \"/{bookId}/templates/{templateId}/logo\""
        },
        "billingAddress": true,
        "shippingAddress": true,
        "estimateDate": true,
        "estimateNumber": true,
        "expiryDate": true,
        "referenceCode": true,
        "customText": true,
        "customTextValue": "custom text"
      },
      "content": {
        "project": true,
        "item": true,
        "itemPrice": true,
        "description": true,
        "quantity": true,
        "taxCode": true,
        "tax": true,
        "amount": true
      },
      "footer": {
        "note": true,
        "subtotal": true,
        "taxAmount": true,
        "totalExcludingTax": true,
        "total": true,
        "termsAndConditions": true,
        "paymentNotes": true,
        "signature": true
      }
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The template's id.",
            "format": "guid",
            "example": "d45f44de-e37e-4cb6-8685-d2b96e4bf720"
          },
          "name": {
            "type": "string",
            "description": "The template's name.",
            "example": "Standard Invoice"
          },
          "font": {
            "type": "string",
            "description": "The template's font.",
            "nullable": true,
            "example": "Open Sans"
          },
          "fontSize": {
            "type": "number",
            "description": "The template's font size.",
            "format": "float",
            "example": 7.0
          },
          "header": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "companyName": {
                    "type": "boolean",
                    "description": "Is CompanyName included in the template's header.",
                    "example": true
                  },
                  "companyAddress": {
                    "type": "boolean",
                    "description": "Is CompanyAddress included in the template's header.",
                    "example": true
                  },
                  "taxNumber": {
                    "type": "boolean",
                    "description": "Is TaxNumber included in the template's header.",
                    "example": true
                  },
                  "phoneNumber": {
                    "type": "boolean",
                    "description": "Is PhoneNumber included in the template's header.",
                    "example": true
                  },
                  "email": {
                    "type": "boolean",
                    "description": "Is Email included in the template's header.",
                    "example": true
                  },
                  "website": {
                    "type": "boolean",
                    "description": "Is Website included in the template's header.",
                    "example": true
                  },
                  "logo": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the logo.",
                            "example": "giant800px-Coca-Cola_logo.svg.png"
                          },
                          "url": {
                            "type": "string",
                            "description": "Url of the logo.",
                            "example": "\"url\": \"/{bookId}/templates/{templateId}/logo\""
                          }
                        },
                        "additionalProperties": false,
                        "description": "Details of a logo."
                      }
                    ],
                    "description": "Logo of the template's header.",
                    "nullable": true
                  },
                  "billingAddress": {
                    "type": "boolean",
                    "description": "Is billing address included in the template's header.",
                    "example": true
                  },
                  "shippingAddress": {
                    "type": "boolean",
                    "description": "Is shipping address included in the template's header.",
                    "example": true
                  },
                  "estimateDate": {
                    "type": "boolean",
                    "description": "Is estimate date included in the template's header.",
                    "example": true
                  },
                  "estimateNumber": {
                    "type": "boolean",
                    "description": "Is estimate number included in the template's header.",
                    "example": true
                  },
                  "expiryDate": {
                    "type": "boolean",
                    "description": "Is expiry date included in the template's header.",
                    "example": true
                  },
                  "referenceCode": {
                    "type": "boolean",
                    "description": "Is reference code included in the template's header.",
                    "example": true
                  },
                  "customText": {
                    "type": "boolean",
                    "description": "Is custom text included in the template's header.",
                    "example": true
                  },
                  "customTextValue": {
                    "type": "string",
                    "description": "The custom text value of the template's header.",
                    "nullable": true,
                    "example": "custom text"
                  }
                },
                "additionalProperties": false,
                "description": "Details of the header of an estimate template."
              }
            ],
            "description": "The header details of the template."
          },
          "content": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "project": {
                    "type": "boolean",
                    "description": "Is Project included in the template's content.",
                    "example": true
                  },
                  "item": {
                    "type": "boolean",
                    "description": "Is Item included in the template's content.",
                    "example": true
                  },
                  "itemPrice": {
                    "type": "boolean",
                    "description": "Is ItemPrice included in the template's content.",
                    "example": true
                  },
                  "description": {
                    "type": "boolean",
                    "description": "Is Description included in the template's content.",
                    "example": true
                  },
                  "quantity": {
                    "type": "boolean",
                    "description": "Is Quantity included in the template's content.",
                    "example": true
                  },
                  "taxCode": {
                    "type": "boolean",
                    "description": "Is TaxCode included in the template's content.",
                    "example": true
                  },
                  "tax": {
                    "type": "boolean",
                    "description": "Is Tax included in the template's content.",
                    "example": true
                  },
                  "amount": {
                    "type": "boolean",
                    "description": "Is Amount included in the template's content.",
                    "example": true
                  }
                },
                "additionalProperties": false,
                "description": "Details of the content of a template."
              }
            ],
            "description": "The content's details of the template."
          },
          "footer": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "note": {
                    "type": "boolean",
                    "description": "Is Note included in the template's footer.",
                    "example": true
                  },
                  "subtotal": {
                    "type": "boolean",
                    "description": "Is Subtotal included in the template's footer.",
                    "example": true
                  },
                  "taxAmount": {
                    "type": "boolean",
                    "description": "Is TaxAmount included in the template's footer.",
                    "example": true
                  },
                  "totalExcludingTax": {
                    "type": "boolean",
                    "description": "Is total excluding tax included in the template's footer.",
                    "example": true
                  },
                  "total": {
                    "type": "boolean",
                    "description": "Is total included in the template's footer.",
                    "example": true
                  },
                  "termsAndConditions": {
                    "type": "boolean",
                    "description": "Is terms and conditions included in the template's footer.",
                    "example": true
                  },
                  "paymentNotes": {
                    "type": "boolean",
                    "description": "Is payment notes included in the template's footer.",
                    "example": true
                  },
                  "signature": {
                    "type": "boolean",
                    "description": "Is signature included in the template's footer.",
                    "example": true
                  }
                },
                "additionalProperties": false,
                "description": "Details of the footer of an estimate template."
              }
            ],
            "description": "The footer details of the template."
          }
        },
        "additionalProperties": false,
        "description": "Details of an estimate template."
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of estimate templates."
}

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 retrieve the templates.

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 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 GET "https://api.reckon.com/r1/v2/{bookId}/templates/estimates?page=1&perPage=0"
-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["page"] = "1";
            queryString["perPage"] = "0";
            var uri = "https://api.reckon.com/r1/v2/{bookId}/templates/estimates?" + 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.reckon.com/r1/v2/{bookId}/templates/estimates");

            builder.setParameter("page", "1");
            builder.setParameter("perPage", "0");

            URI uri = builder.build();
            HttpGet request = new HttpGet(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
            "page": "1",
            "perPage": "0",
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/templates/estimates?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            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.reckon.com/r1/v2/{bookId}/templates/estimates";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"page=1",
                         @"perPage=0",
                      ];
    
    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:@"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}/templates/estimates');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'page' => '1',
    'perPage' => '0',
);

$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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'page': '1',
    'perPage': '0',
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/templates/estimates?%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
    'page': '1',
    'perPage': '0',
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/templates/estimates?%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}/templates/estimates')

query = URI.encode_www_form({
    # Request parameters
    'page' => '1',
    'perPage' => '0'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.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