Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of items.

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

Get a paged list of items for the specified book.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/items

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/items?page=2&perpage=20

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/items?select=id,name

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/items?filter=name eq "Product A"

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/items?orderby=itemtype desc,name

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). The date to use when calculating the net or gross price.

  • (optional)
    integer

    Format - int32. The page to retrieve.

  • (optional)
    integer

    Format - int32. The number of items 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 items for the specified book.

Representations

{
  "list": [
    {
      "id": "d1b8ced5-ff7d-4a47-96fa-10bfbe0990d6",
      "name": "Green Widget",
      "fullName": "Widgets:Green Widget",
      "parentItem": {
        "id": "926d2c6c-d489-47b3-8813-9f62a8499994",
        "name": "Widgets"
      },
      "itemType": "Product",
      "itemCode": "WID001",
      "amountTaxStatus": "Inclusive",
      "status": "Active",
      "purchase": {
        "price": 4.54545455,
        "priceNet": 4.54545455,
        "priceGross": 5,
        "priceAccuracy": 8,
        "ledgerAccount": {
          "id": "59bfdb84-ab9c-4fa6-8364-b2ed60b87f31",
          "name": "Cost of Sales"
        },
        "description": "A green widget that can be bought",
        "taxRate": {
          "id": "9f85a156-8a3b-449a-893b-02d603daee3b",
          "name": "NCG",
          "rate": 10
        }
      },
      "sale": {
        "price": 4.54545455,
        "priceNet": 4.54545455,
        "priceGross": 5,
        "priceAccuracy": 8,
        "ledgerAccount": {
          "id": "7667528a-c88c-4e6d-b55b-2d43177d16f0",
          "name": "Income"
        },
        "description": "A green widget that can be sold",
        "taxRate": {
          "id": "d45f44de-e37e-4cb6-8685-d2b96e4bf720",
          "name": "GST",
          "rate": 10
        }
      },
      "createdDateTime": "2020-02-06T04:13:45Z",
      "lastModifiedDateTime": "2020-02-06T04:13:45Z",
      "externalClient": {
        "id": "2296ba1d-c0c4-44d2-bf12-9681098a9afa",
        "tenancyId": "1293848",
        "resourceId": "134"
      }
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The item's unique id.",
            "format": "guid",
            "example": "d1b8ced5-ff7d-4a47-96fa-10bfbe0990d6"
          },
          "name": {
            "type": "string",
            "description": "The name of the item.",
            "example": "Green Widget"
          },
          "fullName": {
            "type": "string",
            "description": "The full name of the item.",
            "example": "Widgets:Green Widget"
          },
          "parentItem": {
            "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 item."
              }
            ],
            "description": "The parent item if there is one.",
            "nullable": true,
            "example": {
              "id": "926d2c6c-d489-47b3-8813-9f62a8499994",
              "name": "Widgets"
            }
          },
          "itemType": {
            "oneOf": [
              {
                "enum": [
                  "Product",
                  "Service"
                ],
                "type": "string",
                "description": "The item type.",
                "x-enumNames": [
                  "Product",
                  "Service"
                ]
              }
            ],
            "description": "The item type.",
            "example": "Product"
          },
          "itemCode": {
            "type": "string",
            "description": "The item code.",
            "nullable": true,
            "example": "WID001"
          },
          "amountTaxStatus": {
            "oneOf": [
              {
                "enum": [
                  "Inclusive",
                  "Exclusive"
                ],
                "type": "string",
                "description": "The tax status of an item's amount.",
                "x-enumNames": [
                  "Inclusive",
                  "Exclusive"
                ]
              }
            ],
            "description": "The amount tax status of the amounts in the item.\nThis determines whether item prices include or exclude tax (i.e. gross or net).",
            "example": "Inclusive"
          },
          "status": {
            "oneOf": [
              {
                "enum": [
                  "Active",
                  "Inactive"
                ],
                "type": "string",
                "description": "The status of an item.",
                "x-enumNames": [
                  "Active",
                  "Inactive"
                ]
              }
            ],
            "description": "The item status.",
            "example": "Active"
          },
          "purchase": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "price": {
                    "type": "number",
                    "description": "The item's price.\nIf the item's `amountTaxStatus` is `Inclusive` then the price includes tax (gross).\nIf the item's `amountTaxStatus` is `Exclusive` then the price excludes tax (net).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 100.0
                  },
                  "priceNet": {
                    "type": "number",
                    "description": "The item's price excluding tax (net).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 100.0
                  },
                  "priceGross": {
                    "type": "number",
                    "description": "The item's price including tax (gross).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 110.0
                  },
                  "priceAccuracy": {
                    "type": "integer",
                    "description": "The accuracy (number of decimal places) of the price.",
                    "format": "byte",
                    "nullable": true,
                    "example": 2
                  },
                  "ledgerAccount": {
                    "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 ledger account."
                      }
                    ],
                    "description": "The ledger account.",
                    "example": "expenses"
                  },
                  "description": {
                    "type": "string",
                    "description": "The description.",
                    "nullable": true,
                    "example": "sell item 1"
                  },
                  "taxRate": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The unique id.",
                            "format": "guid",
                            "nullable": true
                          },
                          "name": {
                            "type": "string",
                            "description": "The unique name.",
                            "nullable": true
                          },
                          "percent": {
                            "type": "number",
                            "description": "Tax rate value as a percentage.",
                            "format": "decimal"
                          }
                        },
                        "additionalProperties": false,
                        "description": "Reference to a tax rate."
                      }
                    ],
                    "description": "The tax rate.",
                    "nullable": true,
                    "example": {
                      "id": "2d276d3a-85cb-4ae3-b23c-cfcdb26510b8",
                      "name": "GST",
                      "percent": 10
                    }
                  }
                },
                "additionalProperties": false,
                "description": "Item usage details."
              }
            ],
            "description": "Details for the item when it is purchased.",
            "nullable": true,
            "example": {
              "price": 4.54545455,
              "priceNet": 4.54545455,
              "priceGross": 5,
              "priceAccuracy": 8,
              "ledgerAccount": {
                "id": "59bfdb84-ab9c-4fa6-8364-b2ed60b87f31",
                "name": "Cost of Sales"
              },
              "description": "A green widget that can be bought",
              "taxRate": {
                "id": "9f85a156-8a3b-449a-893b-02d603daee3b",
                "name": "NCG",
                "rate": 10
              }
            }
          },
          "sale": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "price": {
                    "type": "number",
                    "description": "The item's price.\nIf the item's `amountTaxStatus` is `Inclusive` then the price includes tax (gross).\nIf the item's `amountTaxStatus` is `Exclusive` then the price excludes tax (net).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 100.0
                  },
                  "priceNet": {
                    "type": "number",
                    "description": "The item's price excluding tax (net).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 100.0
                  },
                  "priceGross": {
                    "type": "number",
                    "description": "The item's price including tax (gross).",
                    "format": "decimal",
                    "nullable": true,
                    "example": 110.0
                  },
                  "priceAccuracy": {
                    "type": "integer",
                    "description": "The accuracy (number of decimal places) of the price.",
                    "format": "byte",
                    "nullable": true,
                    "example": 2
                  },
                  "ledgerAccount": {
                    "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 ledger account."
                      }
                    ],
                    "description": "The ledger account.",
                    "example": "expenses"
                  },
                  "description": {
                    "type": "string",
                    "description": "The description.",
                    "nullable": true,
                    "example": "sell item 1"
                  },
                  "taxRate": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The unique id.",
                            "format": "guid",
                            "nullable": true
                          },
                          "name": {
                            "type": "string",
                            "description": "The unique name.",
                            "nullable": true
                          },
                          "percent": {
                            "type": "number",
                            "description": "Tax rate value as a percentage.",
                            "format": "decimal"
                          }
                        },
                        "additionalProperties": false,
                        "description": "Reference to a tax rate."
                      }
                    ],
                    "description": "The tax rate.",
                    "nullable": true,
                    "example": {
                      "id": "2d276d3a-85cb-4ae3-b23c-cfcdb26510b8",
                      "name": "GST",
                      "percent": 10
                    }
                  }
                },
                "additionalProperties": false,
                "description": "Item usage details."
              }
            ],
            "description": "Details for the item when it is sold.",
            "nullable": true,
            "example": {
              "price": 4.54545455,
              "priceNet": 4.54545455,
              "priceGross": 5,
              "priceAccuracy": 8,
              "ledgerAccount": {
                "id": "7667528a-c88c-4e6d-b55b-2d43177d16f0",
                "name": "Income"
              },
              "description": "A green widget that can be sold",
              "taxRate": {
                "id": "d45f44de-e37e-4cb6-8685-d2b96e4bf720",
                "name": "GST",
                "rate": 10
              }
            }
          },
          "createdDateTime": {
            "type": "string",
            "description": "The date and time when the item was created.",
            "format": "date-time",
            "example": "2020-02-06T04:13:45Z"
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "The date and time when the item was last modified.",
            "format": "date-time",
            "example": "2020-02-06T04:13:45Z"
          },
          "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
          }
        },
        "additionalProperties": false,
        "description": "Details of an item."
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of items."
}

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

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

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

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'baseDate' => '{string}',
    '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
    'baseDate': '{string}',
    'page': '1',
    'perPage': '0',
    'ExternalClientId': '{string}',
    'ExternalTenancyId': '{string}',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    'baseDate' => '{string}',
    '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