Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Creates a new ledger account.

Create a new ledger account.

POST /5af6572c-9771-4b86-995d-3374d3bc683c/ledgeraccounts

Bank accounts

When creating a bank account, you can provide additional details via the bankAccount field. You must omit the parentLedgerAccount and defaultTaxRate fields.

Credit account

When creating a credit account (for a credit card for example), you can provide additional details via the creditAccount field. You must omit the parentLedgerAccount and defaultTaxRate fields.

Any other account

When creating any other account, you must omit the bankAccount and creditAccount fields.

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book'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)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

The account to create.

{
  "name": "Widget income",
  "description": "empty string",
  "parentLedgerAccount": "null",
  "sortOrder": 0,
  "status": "Active",
  "defaultTaxRate": "null",
  "accountType": "Income",
  "accountCode": "null",
  "exportCode": "null",
  "bankAccount": "null",
  "creditAccount": "null"
}
{
  "required": [
    "name",
    "accountType"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 260,
      "minLength": 1,
      "type": "string",
      "description": "The name of the account.",
      "example": "Widget income"
    },
    "description": {
      "maxLength": 300,
      "type": "string",
      "description": "The description of the account.",
      "default": "empty string",
      "nullable": true,
      "example": "Income from sales of widgets"
    },
    "parentLedgerAccount": {
      "type": "string",
      "description": "The parent ledger account if there is one.",
      "default": "null",
      "nullable": true,
      "example": "Income"
    },
    "sortOrder": {
      "type": "integer",
      "description": "The order in which the user would like to sort the account relative to other accounts.",
      "format": "int32",
      "default": 0,
      "nullable": true,
      "example": 1
    },
    "status": {
      "oneOf": [
        {
          "enum": [
            "Active",
            "Inactive"
          ],
          "type": "string",
          "description": "The status of a ledger account.",
          "x-enumNames": [
            "Active",
            "Inactive"
          ]
        }
      ],
      "description": "The account status.",
      "default": "Active",
      "nullable": true,
      "example": "Active"
    },
    "defaultTaxRate": {
      "type": "string",
      "description": "The default tax rate for the account.",
      "default": "null",
      "nullable": true,
      "example": "NCG"
    },
    "accountType": {
      "oneOf": [
        {
          "enum": [
            "Income",
            "Expense",
            "CurrentAsset_Other",
            "CurrentLiability_Other",
            "Equity",
            "Income_Other",
            "Expense_Other",
            "Expense_CostOfGoodsSold",
            "CurrentAsset_Bank",
            "CurrentAsset_AccountsReceivable",
            "NonCurrentAsset_Fixed",
            "NonCurrentAsset_Other",
            "CurrentLiability_CreditCard",
            "CurrentLiability_AccountsPayable",
            "NonCurrentLiability"
          ],
          "type": "string",
          "description": "The ledger account type.",
          "x-enumNames": [
            "Income",
            "Expense",
            "CurrentAsset_Other",
            "CurrentLiability_Other",
            "Equity",
            "Income_Other",
            "Expense_Other",
            "Expense_CostOfGoodsSold",
            "CurrentAsset_Bank",
            "CurrentAsset_AccountsReceivable",
            "NonCurrentAsset_Fixed",
            "NonCurrentAsset_Other",
            "CurrentLiability_CreditCard",
            "CurrentLiability_AccountsPayable",
            "NonCurrentLiability"
          ]
        }
      ],
      "description": "The account type.",
      "example": "Income"
    },
    "accountCode": {
      "maxLength": 10,
      "type": "string",
      "description": "The account code.",
      "default": "null",
      "nullable": true,
      "example": "2-2040"
    },
    "exportCode": {
      "maxLength": 30,
      "type": "string",
      "description": "The export code for the account.",
      "default": "null",
      "nullable": true,
      "example": "ABC-99"
    },
    "bankAccount": {
      "oneOf": [
        {
          "required": [
            "includeBalancingTransaction"
          ],
          "type": "object",
          "properties": {
            "dateOpened": {
              "type": "string",
              "description": "When the bank account was opened.",
              "format": "date-time",
              "default": "null",
              "nullable": true,
              "example": "2020-05-14T12:00:00Z"
            },
            "lockoffDate": {
              "type": "string",
              "description": "The date when transactions are locked.\nTransactions dated on or before this date cannot be amended.",
              "format": "date-time",
              "default": "null",
              "nullable": true,
              "example": "2020-06-30T12:00:00Z"
            },
            "bankBranchNumber": {
              "type": "string",
              "description": "The bank branch number (BSB in Australia, Sort Code in UK).",
              "default": "null",
              "nullable": true,
              "example": "123456"
            },
            "bankAccountName": {
              "maxLength": 26,
              "type": "string",
              "description": "The name of the account holder.",
              "nullable": true,
              "example": "John Smith"
            },
            "bankAccountNumber": {
              "type": "string",
              "description": "The bank account number.",
              "default": "null",
              "nullable": true,
              "example": "987654"
            },
            "openingBalance": {
              "type": "number",
              "description": "The bank account's opening balance.",
              "format": "decimal",
              "default": "null",
              "nullable": true,
              "example": 1000.0
            },
            "financialInstitution": {
              "type": "string",
              "description": "The id of the financial institution.",
              "format": "guid",
              "default": "null",
              "nullable": true,
              "example": "76efba3f-2483-4bb8-88e3-7f0786366a6c"
            },
            "includeBalancingTransaction": {
              "type": "boolean",
              "description": "Whether to include a balancing transaction.",
              "example": false
            },
            "payerIdentifier": {
              "type": "string",
              "description": "The APCA number to identify the payer.",
              "default": "null",
              "nullable": true,
              "example": "125876"
            }
          },
          "additionalProperties": false,
          "description": "Bank account details."
        }
      ],
      "description": "The bank account details - **only** when the `accountType` is `CurrentAsset_Bank`.",
      "default": "null",
      "nullable": true
    },
    "creditAccount": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "dateOpened": {
              "type": "string",
              "description": "When the credit account was opened.",
              "format": "date-time",
              "default": "null",
              "nullable": true,
              "example": "2020-05-14T12:00:00Z"
            },
            "lockoffDate": {
              "type": "string",
              "description": "The date when transactions are locked.\nTransactions dated on or before this date cannot be amended.",
              "format": "date-time",
              "default": "null",
              "nullable": true,
              "example": "2020-06-30T12:00:00Z"
            },
            "openingBalance": {
              "type": "number",
              "description": "The credit account's opening balance.",
              "format": "decimal",
              "default": "null",
              "nullable": true,
              "example": 1000.0
            }
          },
          "additionalProperties": false,
          "description": "Credit account details."
        }
      ],
      "description": "The credit account details - **only** when the `accountType` is `CurrentLiability_CreditCard`.",
      "default": "null",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Details of a ledger account to create."
}

Responses

201 Created

The id of the account that has been created.

Representations

{
  "id": "4914677a-e30e-4cfb-aef7-15ac09c697e6"
}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The resource's id as guid.",
      "format": "guid"
    }
  },
  "additionalProperties": false,
  "description": "A response that contains the resource's id.",
  "example": {
    "id": "4914677a-e30e-4cfb-aef7-15ac09c697e6"
  }
}

400 Bad Request

The ledger account could not be created 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 create a new ledger account.

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 POST "https://api.reckon.com/r1/v2/{bookId}/ledgeraccounts?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}/ledgeraccounts?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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}/ledgeraccounts");

            builder.setParameter("ExternalResourceId", "{string}");
            builder.setParameter("ExternalClientId", "{string}");
            builder.setParameter("ExternalTenancyId", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(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}/ledgeraccounts?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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}/ledgeraccounts";
    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:@"POST"];
    // 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}/ledgeraccounts');
$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_POST);

// 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("POST", "/r1/v2/{bookId}/ledgeraccounts?%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("POST", "/r1/v2/{bookId}/ledgeraccounts?%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}/ledgeraccounts')

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::Post.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