Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Get a book's general settings.
Get general settings for the specified book.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/settings
Get just the required fields, e.g. book name and start date. Find out more about selecting.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/settings?select=bookname,startdate
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
Request headers
Request body
Responses
200 OK
The general settings for the specified book.
Representations
{
"bookName": "ACME",
"startDate": "2018-07-01T12:00:00Z",
"bookCreatedDateTime": "2018-07-01T10:11:00Z",
"lockOffDate": "2019-06-30T12:00:00Z",
"financialYearStartDay": 1,
"financialYearStartMonth": 7,
"entity": {
"id": "04cf3464-a14a-4221-9aa3-865e067fbf9f",
"name": "Company"
},
"industry": {
"id": "ccd0c57a-2801-45df-9698-258d7db57bde",
"name": "Accommodation and food services"
},
"category": {
"id": "c863c380-c5fa-4495-afe9-568f7041774c",
"name": "Cafes, restaurants and takeaway food services"
},
"businessType": {
"id": "d11a082a-104e-48f4-9a57-f90d0180faf9",
"name": "Fast food retailing"
},
"replyToEmailAddress": "john.doe@acme.com",
"showEmailSentFrom": "John Smith",
"bankDataRetrievalDays": 30,
"generalDetails": {
"companyName": "Joe's Hot Potatoes",
"legalName": "Joe Sanders Food Service Pty Ltd",
"taxNumber": "123456782",
"isRegisteredEmployerOfWHM": true,
"branchNumber": "002",
"businessNumber": "9429037829131"
},
"addresses": [
{
"id": "string",
"type": {
"name": "Postal",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
},
"line1": "Floor 1",
"line2": "Apartment 44",
"line3": "1 Tudor Lane",
"town": "London",
"suburb": "Collingwood",
"state": "Victoria",
"postcode": "3000",
"country": "Australia"
}
],
"contactDetails": {
"contactName": "Joe Sanders",
"phoneNumbers": [
{
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47",
"type": {
"name": "Work",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
},
"areaCode": "02",
"number": "90101234"
}
],
"electronicAddresses": [
{
"id": "string",
"type": {
"name": "Email",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
},
"address": "x@y.com"
}
]
}
}
{
"type": "object",
"properties": {
"bookName": {
"type": "string",
"description": "The book's name.",
"example": "ACME"
},
"startDate": {
"type": "string",
"description": "The first day of records for the book.",
"format": "date-time",
"example": "2018-07-01T12:00:00Z"
},
"bookCreatedDateTime": {
"type": "string",
"description": "Date and time when the book was created.",
"format": "date-time",
"example": "2018-07-01T10:11:00Z"
},
"lockOffDate": {
"type": "string",
"description": "Transactions on or before this date cannot be changed.",
"format": "date-time",
"nullable": true,
"example": "2019-06-30T12:00:00Z"
},
"financialYearStartDay": {
"type": "integer",
"description": "Day of month the financial year starts on.",
"format": "int32",
"example": 1
},
"financialYearStartMonth": {
"type": "integer",
"description": "Month as a number that the financial year starts in.",
"format": "int32",
"example": 7
},
"entity": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to an entity."
}
],
"description": "Entity type of business.",
"nullable": true,
"example": {
"id": "04cf3464-a14a-4221-9aa3-865e067fbf9f",
"name": "Company"
}
},
"industry": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to an industry."
}
],
"description": "Industry of business.",
"nullable": true,
"example": {
"id": "ccd0c57a-2801-45df-9698-258d7db57bde",
"name": "Accommodation and food services"
}
},
"category": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to an industry's category."
}
],
"description": "Industry's category of business.",
"nullable": true,
"example": {
"id": "c863c380-c5fa-4495-afe9-568f7041774c",
"name": "Cafes, restaurants and takeaway food services"
}
},
"businessType": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to an industry category's business type."
}
],
"description": "Industry category's business type.",
"nullable": true,
"example": {
"id": "d11a082a-104e-48f4-9a57-f90d0180faf9",
"name": "Fast food retailing"
}
},
"replyToEmailAddress": {
"type": "string",
"description": "The email address used by clients when replying to emails sent from Reckon One.",
"nullable": true,
"example": "john.doe@acme.com"
},
"showEmailSentFrom": {
"type": "string",
"description": "The displayed name of sender in emails.",
"nullable": true,
"example": "John Smith"
},
"bankDataRetrievalDays": {
"type": "integer",
"description": "The number of most recent days bank data is retrieved for.",
"format": "int32",
"example": 30
},
"generalDetails": {
"oneOf": [
{
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "The company's business/trading name.",
"nullable": true,
"example": "Joe's Hot Potatoes"
},
"legalName": {
"type": "string",
"description": "The name of the company that appears on legal documents.",
"nullable": true,
"example": "Joe Sanders Food Services Pty Ltd"
},
"taxNumber": {
"type": "string",
"description": "The tax number of the company, for example, 'ABN/WPN' for AU and 'GST/IRD number' for NZ.",
"nullable": true,
"example": "123456782"
},
"isRegisteredEmployerOfWHM": {
"type": "boolean",
"description": "Whether the company is a registered WHM employer.",
"example": true
},
"branchNumber": {
"type": "string",
"description": "The branch number associated with the tax number.",
"nullable": true,
"example": "002"
},
"businessNumber": {
"type": "string",
"description": "The business number of the company, for example, New Zealand Business Number (NZBN).",
"nullable": true,
"example": "9429037829131"
}
},
"additionalProperties": false,
"description": "Basic business details"
}
],
"description": "General company details",
"nullable": true,
"example": {
"companyName": "Joe's Hot Potatoes",
"legalName": "Joe Sanders Food Service Pty Ltd",
"taxNumber": "123456782",
"isRegisteredEmployerOfWHM": true,
"branchNumber": "002",
"businessNumber": "9429037829131"
}
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The address's unique id.",
"nullable": true
},
"type": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Type reference."
}
],
"description": "The address type.",
"example": {
"name": "Postal",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
}
},
"line1": {
"type": "string",
"description": "First line of address.",
"nullable": true,
"example": "Floor 1"
},
"line2": {
"type": "string",
"description": "Second line of address.",
"nullable": true,
"example": "Apartment 44"
},
"line3": {
"type": "string",
"description": "Third line of address.",
"nullable": true,
"example": "1 Tudor Lane"
},
"town": {
"type": "string",
"description": "Town of address.",
"nullable": true,
"example": "London"
},
"suburb": {
"type": "string",
"description": "Suburb of address.",
"nullable": true,
"example": "Collingwood"
},
"state": {
"type": "string",
"description": "State of address.",
"nullable": true,
"example": "Victoria"
},
"postcode": {
"type": "string",
"description": "Postcode of address.",
"nullable": true,
"example": "3000"
},
"country": {
"type": "string",
"description": "Country of address.",
"nullable": true,
"example": "Australia"
}
},
"additionalProperties": false,
"description": "An address."
},
"description": "List of addresses.",
"nullable": true
},
"contactDetails": {
"oneOf": [
{
"type": "object",
"properties": {
"contactName": {
"type": "string",
"description": "Name of person who is primary contact within the business.",
"nullable": true,
"example": "Joe Sanders"
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The phone number's unique id.",
"nullable": true,
"example": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
},
"type": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Type reference."
}
],
"description": "The type of phone number.",
"nullable": true,
"example": {
"name": "Work",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
}
},
"areaCode": {
"type": "string",
"description": "The area code.",
"nullable": true,
"example": "02"
},
"number": {
"type": "string",
"description": "The number.",
"nullable": true,
"example": "90101234"
}
},
"additionalProperties": false,
"description": "A phone number."
},
"description": "List of phone numbers.",
"nullable": true
},
"electronicAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The electronic address's unique id.",
"nullable": true
},
"type": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Type reference."
}
],
"description": "Type of electronic address.",
"nullable": true,
"example": {
"name": "Email",
"id": "5ACEA92F-13C2-49F8-9179-AF4934F29E47"
}
},
"address": {
"type": "string",
"description": "The electronic address.",
"nullable": true,
"example": "x@y.com"
}
},
"additionalProperties": false,
"description": "An electronic address."
},
"description": "List of electronic addresses.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Details on how to contact the business."
}
],
"description": "Business's contact details.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A book's general settings"
}
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 book settings.
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}/settings"
-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}");
var uri = "https://api.reckon.com/r1/v2/{bookId}/settings?" + 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}/settings");
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
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/settings?" + $.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}/settings";
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:@"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}/settings');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/settings?%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({
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/settings?%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}/settings')
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