Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Updates selected fields of an existing super fund.
Patch an existing super fund.
Note: The Content-Type
header must be application/merge-patch+json
.
PATCH /e7e3ba02-05e2-4bea-9348-85876c9952ba/superfunds/6df2ff1f-1565-46ab-8ce8-760f2ae009f8
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
-
string
Format - guid. The super fund's id.
-
(optional)string
The external resource's id.
-
(optional)string
Format - guid. The external client application's id.
-
(optional)string
The external book/file/tenancy/etc's id.
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Details of the updated super fund to change.
{
"name": "John Doe",
"organisationName": "Reckon Co.",
"branch": "1234",
"notes": "The person to call.",
"businessNumber1": "0218001234",
"businessNumber2": "0218001234",
"businessNumber": "0218001234123",
"status": "Active",
"entityTypes": {
"IsCustomer": false,
"IsSupplier": true
},
"bankDetails": {
"name": "My bank account",
"bankBranchNumber": "123456",
"bankAccountNumber": "444555"
},
"superFundDetails": {
"superfundProvider": {
"fund": "8B395C9B-1EFE-4703-8F50-00AD238A755A",
"employerNumber": "E123456"
},
"smsf": {
"fundName": "iAccess Personal Superannuation",
"electronicServiceAddress": "x@y.com"
}
}
}
{
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"type": "string",
"description": "The organisation's display name.",
"nullable": true,
"example": "John Doe"
},
"organisationName": {
"maxLength": 100,
"type": "string",
"description": "The organisation's name.",
"nullable": true,
"example": "Reckon Co."
},
"branch": {
"maxLength": 100,
"type": "string",
"description": "The organisation's branch.",
"nullable": true,
"example": "1234"
},
"notes": {
"maxLength": 1000,
"type": "string",
"description": "Notes for the organisation.",
"nullable": true,
"example": "The person to call."
},
"businessNumber1": {
"maxLength": 20,
"type": "string",
"description": "The organisation's business number 1.",
"nullable": true,
"example": "0218001234"
},
"businessNumber2": {
"maxLength": 20,
"type": "string",
"description": "The organisation's business number 2.",
"nullable": true,
"example": "0218001234"
},
"businessNumber": {
"maxLength": 20,
"type": "string",
"description": "This applies to NZBN number.",
"nullable": true,
"example": "0218001234123"
},
"status": {
"type": "string",
"description": "The status of the organisation. (Active/Inactive)",
"nullable": true,
"example": "Active"
},
"entityTypes": {
"oneOf": [
{
"type": "object",
"properties": {
"isCustomer": {
"type": "boolean",
"description": "Is the entity a customer.",
"nullable": true,
"example": false
},
"isSupplier": {
"type": "boolean",
"description": "Is the entity a supplier.",
"nullable": true,
"example": false
},
"isEmployee": {
"type": "boolean",
"description": "Is the entity an employee.",
"nullable": true,
"example": false
},
"isSuperfund": {
"type": "boolean",
"description": "Is the entity a superfund.",
"nullable": true,
"example": false
}
},
"additionalProperties": false,
"description": "Contact's entity types."
}
],
"description": "If the entity has other entity types.",
"nullable": true,
"example": {
"IsCustomer": false,
"IsSupplier": true
}
},
"bankDetails": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The bank account's name.",
"nullable": true,
"example": "My bank account"
},
"bankBranchNumber": {
"type": "string",
"description": "The bank account's branch number.",
"nullable": true,
"example": "123456"
},
"bankAccountNumber": {
"type": "string",
"description": "The bank account's number.",
"nullable": true,
"example": "444555"
}
},
"additionalProperties": false,
"description": "Details of a superfund's bank account to patch."
}
],
"description": "The superfund's bank account details.",
"nullable": true
},
"superFundDetails": {
"oneOf": [
{
"type": "object",
"properties": {
"superfundProvider": {
"oneOf": [
{
"type": "object",
"properties": {
"fund": {
"type": "string",
"description": "The superfund provider id",
"nullable": true,
"example": "8B395C9B-1EFE-4703-8F50-00AD238A755A"
},
"employerNumber": {
"type": "string",
"description": "APRA type employee number",
"nullable": true,
"example": "E123456"
}
},
"additionalProperties": false,
"description": "Superfund’s details to patch"
}
],
"description": "The superfundProvider details",
"nullable": true
},
"smsf": {
"oneOf": [
{
"type": "object",
"properties": {
"fundName": {
"type": "string",
"description": "The SelfManagedSuperfund (SMSF) Name",
"nullable": true,
"example": "iAccess Personal Superannuation"
},
"electronicServiceAddress": {
"type": "string",
"description": "The electronic address for service",
"nullable": true,
"example": "x@y.com"
}
},
"additionalProperties": false,
"description": "Superfund’s details to patch."
}
],
"description": "The SMSF provider details",
"nullable": true
}
},
"additionalProperties": false,
"description": "Details of a superfund to patch."
}
],
"description": "The superfund's details.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Details of the superfund to patch."
}
string
{
"type": "string",
"format": "binary",
"x-apim-inline": true
}
Responses
204 No Content
The result of the update.
400 Bad Request
The super fund 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 update super funds.
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 super fund 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}/superfunds/{superfundId}?ExternalResourceId={string}&ExternalClientId={string}&ExternalTenancyId={string}"
-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}");
// Request parameters
queryString["ExternalResourceId"] = "{string}";
queryString["ExternalClientId"] = "{string}";
queryString["ExternalTenancyId"] = "{string}";
var uri = "https://api.reckon.com/r1/v2/{bookId}/superfunds/{superfundId}?" + 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}/superfunds/{superfundId}");
builder.setParameter("ExternalResourceId", "{string}");
builder.setParameter("ExternalClientId", "{string}");
builder.setParameter("ExternalTenancyId", "{string}");
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
"ExternalResourceId": "{string}",
"ExternalClientId": "{string}",
"ExternalTenancyId": "{string}",
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/superfunds/{superfundId}?" + $.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}/superfunds/{superfundId}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"ExternalResourceId={string}",
@"ExternalClientId={string}",
@"ExternalTenancyId={string}",
];
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}/superfunds/{superfundId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'ExternalResourceId' => '{string}',
'ExternalClientId' => '{string}',
'ExternalTenancyId' => '{string}',
);
$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({
# Request parameters
'ExternalResourceId': '{string}',
'ExternalClientId': '{string}',
'ExternalTenancyId': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("PATCH", "/r1/v2/{bookId}/superfunds/{superfundId}?%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({
# Request parameters
'ExternalResourceId': '{string}',
'ExternalClientId': '{string}',
'ExternalTenancyId': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("PATCH", "/r1/v2/{bookId}/superfunds/{superfundId}?%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}/superfunds/{superfundId}')
query = URI.encode_www_form({
# Request parameters
'ExternalResourceId' => '{string}',
'ExternalClientId' => '{string}',
'ExternalTenancyId' => '{string}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
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