Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets an employee.

Get a particular employee.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/employees/ddca6e60-31ff-43a7-a152-1d08fba97332

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/employees/ddca6e60-31ff-43a7-a152-1d08fba97332?select=id,name

Try it

Request

Request URL

https://api.reckon.com/r1/v2/{bookId}/employees/{employeeId}

Request parameters

bookId

string

Format - guid. The book's id.
employeeId

string

Format - guid. The employee's id.

Request headers

Ocp-Apim-Subscription-Key

string

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

Request body

Responses

200 OK

The requested contact.

Representations

application/json

Sample
Schema

{
  "id": "99979512-98b3-42ca-a0f4-a9bd6b725857",
  "name": "Joe Bloggs",
  "firstName": "Joe",
  "surname": "Bloggs",
  "notes": "Notes about the employee.",
  "businessNumber1": "14003348730",
  "businessNumber2": "14003348731",
  "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"
    }
  ],
  "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"
    }
  ],
  "otherEntityTypes": [
    {
      "isCustomer": false,
      "isSupplier": false,
      "isEmployee": false,
      "isSuperfund": false
    }
  ],
  "lastModifiedDateTime": "2019-10-15T01:43:25Z"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The employee's unique id.",
      "format": "guid",
      "example": "99979512-98b3-42ca-a0f4-a9bd6b725857"
    },
    "name": {
      "type": "string",
      "description": "The employee's display name.",
      "example": "Joe Bloggs"
    },
    "firstName": {
      "type": "string",
      "description": "The employee's first name.",
      "example": "Joe"
    },
    "surname": {
      "type": "string",
      "description": "The employee's last name.",
      "example": "Bloggs"
    },
    "notes": {
      "type": "string",
      "description": "Additional notes about the employee.",
      "nullable": true,
      "example": "Notes about the employee."
    },
    "businessNumber1": {
      "type": "string",
      "description": "The employee's business number 1.",
      "nullable": true,
      "example": "14003348730"
    },
    "businessNumber2": {
      "type": "string",
      "description": "The employee's business number 2.",
      "nullable": true,
      "example": "14003348731"
    },
    "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": "The employee's addresses.",
      "nullable": true
    },
    "status": {
      "oneOf": [
        {
          "enum": [
            "Active",
            "Inactive"
          ],
          "type": "string",
          "description": "The status of a contact.",
          "x-enumNames": [
            "Active",
            "Inactive"
          ]
        }
      ],
      "description": "The status of the employee.",
      "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
    },
    "otherEntityTypes": {
      "type": "array",
      "items": {
        "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": "A list of other entity types this employee is assigned to.",
      "nullable": true
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The UTC date and time when the employee's details were last modified.",
      "format": "date-time",
      "example": "2019-10-15T01:43:25Z"
    }
  },
  "additionalProperties": false,
  "description": "Details of an employee."
}

401 Unauthorized

The authentication token is missing, expired or invalid.

Representations

application/json

Sample
Schema

{
  "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 employee.

Representations

application/json

Sample
Schema

{
  "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 employee does not exist.

Representations

application/json

Sample
Schema

{
  "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}/employees/{employeeId}"
-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}/employees/{employeeId}?" + 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}/employees/{employeeId}");


            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}/employees/{employeeId}?" + $.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}/employees/{employeeId}";
    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}/employees/{employeeId}');
$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}/employees/{employeeId}?%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}/employees/{employeeId}?%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}/employees/{employeeId}')

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