Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of customers.

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

Get a paged list of customers.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/customers

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/customers?page=2&perpage=2

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/customers?select=id,name

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/customers?filter=name eq "John Doe"

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/customers?orderby=name, status 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 customers per page.

  • (optional)
    string

    Format - guid. The external client application's id.

  • (optional)
    string

    The external book/file/tenancy/etc's id.

Request headers

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

Request body

Responses

200 OK

A paged list of customers for the specified book.

Representations

{
  "list": [
    {
      "id": "c4e3cc74-8e81-4ae0-90d2-324d1e1a4479",
      "name": "John Doe",
      "organisationName": "My customer Pty Ltd",
      "branch": "1234",
      "notes": "the notes",
      "businessNumber1": "18001234",
      "businessNumber2": "18001234",
      "businessNumber": "10987654321",
      "entityTypes": {
        "isCustomer": false,
        "isSupplier": true,
        "isEmployee": false,
        "isSuperfund": false
      },
      "status": "Active",
      "electronicAddresses": [
        {
          "id": "string",
          "type": {
            "id": "a9628717-f060-4565-8e37-21ef430c1410",
            "name": "Email"
          },
          "address": "x@y.com"
        }
      ],
      "phoneNumbers": [
        {
          "id": "string",
          "type": {
            "id": "87e5acc1-814b-49e6-90e8-847e3ffd7671",
            "name": "Work"
          },
          "countryCode": "61",
          "areaCode": "02",
          "number": "90101234",
          "extension": "4321"
        }
      ],
      "addresses": [
        {
          "id": "aa33e31e-2f39-4a18-8fa6-c5e5dca58614",
          "type": {
            "id": "ae515c41-ce3a-4097-bb53-823fbac54791",
            "name": "Billing"
          },
          "line1": "Level 2",
          "line2": "100 Pacific Highway",
          "line3": "Line 3",
          "suburb": "North Sydney",
          "town": "Sydney",
          "state": "NSW",
          "postcode": "2060",
          "country": "Australia"
        }
      ],
      "contacts": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "balance": 5789.35,
      "lastModifiedDateTime": "2020-11-29T01:43:25Z",
      "externalClient": {
        "id": "2296ba1d-c0c4-44d2-bf12-9681098a9afa",
        "tenancyId": "1293848",
        "resourceId": "134"
      },
      "creditLimit": 12.5,
      "paymentTerms": {
        "id": "4cafd978-14ae-4dbe-8774-e86c29fabdc4",
        "name": "Widgets Ltd"
      },
      "invoiceCount": 42
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The organisation's unique id.",
            "format": "guid",
            "example": "c4e3cc74-8e81-4ae0-90d2-324d1e1a4479"
          },
          "name": {
            "type": "string",
            "description": "The organisation's display name.",
            "example": "John Doe"
          },
          "organisationName": {
            "type": "string",
            "description": "The organisation's name.",
            "nullable": true,
            "example": "My customer Pty Ltd"
          },
          "branch": {
            "type": "string",
            "description": "The organisation's branch.",
            "nullable": true,
            "example": "1234"
          },
          "notes": {
            "type": "string",
            "description": "The organisation's notes.",
            "nullable": true,
            "example": "the notes"
          },
          "businessNumber1": {
            "type": "string",
            "description": "The organisation's business number 1.",
            "nullable": true,
            "example": "18001234"
          },
          "businessNumber2": {
            "type": "string",
            "description": "The organisation's business number 2.",
            "nullable": true,
            "example": "18001234"
          },
          "businessNumber": {
            "type": "string",
            "description": "This applies to NZBN number.",
            "nullable": true,
            "example": "10987654321"
          },
          "entityTypes": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "isCustomer": {
                    "type": "boolean",
                    "description": "Is the entity a customer.",
                    "default": false,
                    "nullable": true,
                    "example": false
                  },
                  "isSupplier": {
                    "type": "boolean",
                    "description": "Is the entity a suppleir.",
                    "default": false,
                    "nullable": true,
                    "example": false
                  },
                  "isEmployee": {
                    "type": "boolean",
                    "description": "Is the entity an employee.",
                    "default": false,
                    "nullable": true,
                    "example": false
                  },
                  "isSuperfund": {
                    "type": "boolean",
                    "description": "Is the entity a superfund.",
                    "default": false,
                    "nullable": true,
                    "example": false
                  }
                },
                "additionalProperties": false,
                "description": "Contact's entity types."
              }
            ],
            "description": "The organisation's entity types.",
            "example": {
              "isCustomer": false,
              "isSupplier": true,
              "isEmployee": false,
              "isSuperfund": false
            }
          },
          "status": {
            "oneOf": [
              {
                "enum": [
                  "Active",
                  "Inactive"
                ],
                "type": "string",
                "description": "The status of an organisation.",
                "x-enumNames": [
                  "Active",
                  "Inactive"
                ]
              }
            ],
            "description": "The organisation's status (Active or Inactive).",
            "example": "Active"
          },
          "electronicAddresses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The electronic address's unique id."
                },
                "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": "Reference to an electronic address type."
                    }
                  ],
                  "description": "Type of electronic address.",
                  "example": {
                    "id": "a9628717-f060-4565-8e37-21ef430c1410",
                    "name": "Email"
                  }
                },
                "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
          },
          "phoneNumbers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The phone number's unique id."
                },
                "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": "Reference to a phone type."
                    }
                  ],
                  "description": "The type of phone number.",
                  "example": {
                    "id": "87e5acc1-814b-49e6-90e8-847e3ffd7671",
                    "name": "Work"
                  }
                },
                "countryCode": {
                  "type": "string",
                  "description": "The country code.",
                  "nullable": true,
                  "example": "61"
                },
                "areaCode": {
                  "type": "string",
                  "description": "The area code.",
                  "nullable": true,
                  "example": "02"
                },
                "number": {
                  "type": "string",
                  "description": "The number.",
                  "nullable": true,
                  "example": "90101234"
                },
                "extension": {
                  "type": "string",
                  "description": "The extension.",
                  "nullable": true,
                  "example": "4321"
                }
              },
              "additionalProperties": false,
              "description": "A phone number."
            },
            "description": "List of phone numbers.",
            "nullable": true
          },
          "addresses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The address's unique id.",
                  "example": "aa33e31e-2f39-4a18-8fa6-c5e5dca58614"
                },
                "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": "Reference to an address type."
                    }
                  ],
                  "description": "The address type.",
                  "example": {
                    "id": "ae515c41-ce3a-4097-bb53-823fbac54791",
                    "name": "Billing"
                  }
                },
                "line1": {
                  "type": "string",
                  "description": "Line 1 of the address.",
                  "nullable": true,
                  "example": "Level 2"
                },
                "line2": {
                  "type": "string",
                  "description": "Line 2 of the address.",
                  "nullable": true,
                  "example": "100 Pacific Highway"
                },
                "line3": {
                  "type": "string",
                  "description": "Line 3 of the address.",
                  "nullable": true,
                  "example": "Line 3"
                },
                "suburb": {
                  "type": "string",
                  "description": "The suburb.",
                  "nullable": true,
                  "example": "North Sydney"
                },
                "town": {
                  "type": "string",
                  "description": "The town.",
                  "nullable": true,
                  "example": "Sydney"
                },
                "state": {
                  "type": "string",
                  "description": "The state.",
                  "nullable": true,
                  "example": "NSW"
                },
                "postcode": {
                  "type": "string",
                  "description": "The post code.",
                  "nullable": true,
                  "example": "2060"
                },
                "country": {
                  "type": "string",
                  "description": "The country.",
                  "nullable": true,
                  "example": "Australia"
                }
              },
              "additionalProperties": false,
              "description": "An address."
            },
            "description": "List of addresses.",
            "nullable": true
          },
          "contacts": {
            "type": "array",
            "items": {
              "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 a contact."
            },
            "description": "The organisation's contacts list.",
            "nullable": true
          },
          "balance": {
            "type": "number",
            "description": "The organisation's current balance.",
            "format": "decimal",
            "nullable": true,
            "example": 5789.35
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The organisation's last modified date.",
            "format": "date-time",
            "example": "2020-11-29T01:43:25Z"
          },
          "externalClient": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "The external client application's id.",
                    "format": "guid",
                    "example": "2296ba1d-c0c4-44d2-bf12-9681098a9afa"
                  },
                  "tenancyId": {
                    "type": "string",
                    "description": "The external book/file/tenancy/etc's id.",
                    "nullable": true,
                    "example": "1293848"
                  },
                  "resourceId": {
                    "type": "string",
                    "description": "The external resource's id.",
                    "nullable": true,
                    "example": "134"
                  }
                },
                "additionalProperties": false,
                "description": "Details of an external client's resource."
              }
            ],
            "description": "Details of any external client resource.",
            "nullable": true
          },
          "creditLimit": {
            "type": "number",
            "description": "The customer's credit limit (null for other types).",
            "format": "decimal",
            "nullable": true,
            "example": 12.5
          },
          "paymentTerms": {
            "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 a payment term."
              }
            ],
            "description": "The customer's peyment term (null for other types).",
            "nullable": true,
            "example": {
              "id": "4cafd978-14ae-4dbe-8774-e86c29fabdc4",
              "name": "Widgets Ltd"
            }
          },
          "invoiceCount": {
            "type": "integer",
            "description": "The total number of invoices that have been issued to the organisation.",
            "format": "int32",
            "nullable": true,
            "example": 42
          }
        },
        "additionalProperties": false,
        "description": "A customer"
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of customers."
}

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 customers.

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

            builder.setParameter("page", "1");
            builder.setParameter("perPage", "0");
            builder.setParameter("ExternalClientId", "{string}");
            builder.setParameter("ExternalTenancyId", "{string}");

            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",
            "ExternalClientId": "{string}",
            "ExternalTenancyId": "{string}",
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/customers?" + $.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}/customers";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"page=1",
                         @"perPage=0",
                         @"ExternalClientId={string}",
                         @"ExternalTenancyId={string}",
                      ];
    
    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}/customers');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'page' => '1',
    'perPage' => '0',
    'ExternalClientId' => '{string}',
    'ExternalTenancyId' => '{string}',
);

$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',
    'ExternalClientId': '{string}',
    'ExternalTenancyId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/customers?%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',
    'ExternalClientId': '{string}',
    'ExternalTenancyId': '{string}',
})

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

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

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