Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Updates selected fields of a book's settings.

Patch a book's general settings, excluding the book's name. A book's name can only be changed via Reckon Portal.

Note: The Content-Type header must be application/merge-patch+json.

PATCH /5af6572c-9771-4b86-995d-3374d3bc683c/settings

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

The book settings being altered.

{
  "startDate": "2018-07-01T12:00:00Z",
  "lockOffDate": "2019-06-30T12:00:00Z",
  "entity": "Company",
  "industry": "Accommodation and food services",
  "category": "Cafes, restaurants and takeaway food services",
  "businessType": "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"
  },
  "contactDetails": {
    "contactName": "Joe Sanders"
  }
}
{
  "type": "object",
  "properties": {
    "startDate": {
      "type": "string",
      "description": "The first day of records for the book.",
      "format": "date-time",
      "nullable": true,
      "example": "2018-07-01T12:00: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"
    },
    "entity": {
      "type": "string",
      "description": "The id or name of the entity type of business.",
      "nullable": true,
      "example": "Company"
    },
    "industry": {
      "type": "string",
      "description": "The id or name of the industry of business.",
      "nullable": true,
      "example": "Accommodation and food services"
    },
    "category": {
      "type": "string",
      "description": "The id or name of the industry's category of business.",
      "nullable": true,
      "example": "Cafes, restaurants and takeaway food services"
    },
    "businessType": {
      "type": "string",
      "description": "The id or name of the industry category's business type.",
      "nullable": true,
      "example": "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",
      "nullable": true,
      "example": 30
    },
    "generalDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "companyName": {
              "maxLength": 255,
              "type": "string",
              "description": "The company's business/trading name.",
              "nullable": true,
              "example": "Joe's Hot Potatoes"
            },
            "legalName": {
              "maxLength": 255,
              "type": "string",
              "description": "The name of the company that appears on legal documents.",
              "nullable": true,
              "example": "Joe Sanders Food Services Pty Ltd"
            },
            "taxNumber": {
              "maxLength": 50,
              "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"
            },
            "branchNumber": {
              "maxLength": 10,
              "type": "string",
              "description": "The branch number associated with the tax number.",
              "nullable": true,
              "example": "002"
            },
            "businessNumber": {
              "maxLength": 13,
              "type": "string",
              "description": "The business number of the company, for example, New Zealand Business Number (NZBN).",
              "nullable": true,
              "example": "9429037829131"
            },
            "isRegisteredEmployerOfWHM": {
              "type": "boolean",
              "description": "Whether the company is a registered WHM employer.",
              "example": true
            }
          },
          "additionalProperties": false,
          "description": "Basic business details to patch."
        }
      ],
      "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"
      }
    },
    "contactDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "contactName": {
              "maxLength": 255,
              "type": "string",
              "description": "Name of person who is primary contact within the business.",
              "nullable": true,
              "example": "Joe Sanders"
            }
          },
          "additionalProperties": false,
          "description": "Details on how to contact the business to be patched."
        }
      ],
      "description": "Business's contact details.",
      "nullable": true,
      "example": {
        "contactName": "Joe Sanders"
      }
    }
  },
  "additionalProperties": false,
  "description": "Details of a book's general settings to patch."
}
string
{
  "type": "string",
  "format": "binary",
  "x-apim-inline": true
}

Responses

204 No Content

The result of the update.

400 Bad Request

The book settings could not be updated 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 edit 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."
}

415 Unsupported Media Type

The request must use Content-Type application/merge-patch+json.

Representations

{
  "message": "application/json is not supported. Please use content-type application/merge-patch+json.",
  "code": 415
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "application/json is not supported. Please use content-type application/merge-patch+json."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 415
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 415 Unsupported media type error occurs."
}

Code samples

@ECHO OFF

curl -v -X PATCH "https://api.reckon.com/r1/v2/{bookId}/settings"
-H "Content-Type: application/json"
-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;

        }
    }
}	
// // 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();
            HttpPatch request = new HttpPatch(uri);
            request.setHeader("Content-Type", "application/json");
            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("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PATCH",
            // 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:@"PATCH"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PATCH);

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("PATCH", "/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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("PATCH", "/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::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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