Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Gets a journal.
Get a particular journal.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/journals/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2
Get just the required fields, e.g. id and summary. Find out more about selecting.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/journals/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2?select=id,summary
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
-
string
Format - guid. The journal's id.
Request headers
Request body
Responses
200 OK
The requested journal.
Representations
{
"id": "78fb9685-4293-4b5a-af20-d9815c5fddab",
"journalNumber": "00099",
"summary": "Created on 20 Jan 2022",
"journalDate": "2022-01-20T12:00:00Z",
"amountTaxStatus": "Inclusive",
"status": "Posted",
"journalType": "General",
"description": "System generated bank account opening balance journal.",
"adjustingJournal": false,
"transactionLinks": [
{
"linkId": "JNL-8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd",
"transactionType": "ReversalJournal",
"transactionId": "8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd",
"transactionNumber": "00104R",
"transactionDate": "2022-01-20",
"transactionReference": "Reversal of GJE 00104 Created on 20 Jan 2022",
"transactionAmount": null,
"href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/journals/8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd"
}
],
"lineItems": [
{
"lineId": "8f991c2c-b33d-41e1-aa2e-0641b59c13fc",
"reconciliationStatus": "Cleared",
"transactionType": "Sale",
"ledgerAccount": {
"id": "96e28fa3-89a7-4b40-815e-8c7b18e7eb71",
"name": "Sales"
},
"debit": 200.0,
"credit": null,
"taxRate": {
"id": "ccccaaa6-c181-496e-89b6-cdb96c7d7e55",
"name": "GST",
"rate": 10
},
"taxAmount": 20.0,
"taxIsModified": false,
"notes": "Notes about the line.",
"entity": {
"id": "aa52ba6a-6318-4586-b929-83c46ec7b15c",
"name": "Customer",
"entityTypes": {
"isCustomer": true,
"isSupplier": false,
"isEmployee": false,
"isSuperfund": false
}
},
"project": {
"id": "40f4ab48-4be1-4b47-842a-dc9b3973b3fd",
"name": "Project A:Project B"
},
"classification": {
"id": "9c533a04-8580-4513-ab12-129d99e53b5f",
"name": "My classification"
},
"transactionLinks": [
{
"linkId": "EST-8cc23593-4790-4f56-b2a1-92396b3f2aaf",
"transactionType": "Estimate",
"transactionId": "8cc23593-4790-4f56-b2a1-92396b3f2aaf",
"transactionNumber": "EST0028",
"transactionDate": "2020-02-06T12:00:00Z",
"transactionReference": "Ref 1234",
"transactionAmount": 1000.0,
"href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/estimates/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
}
]
}
]
}{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The journal's unique id.",
"format": "guid",
"example": "78fb9685-4293-4b5a-af20-d9815c5fddab"
},
"journalNumber": {
"type": "string",
"description": "The journal's number.",
"example": "00099"
},
"summary": {
"type": "string",
"description": "Summary of the journal.",
"example": "Created on 20 Jan 2022"
},
"journalDate": {
"type": "string",
"description": "The date of the journal.",
"format": "date-time",
"example": "2022-01-20T12:00:00Z"
},
"amountTaxStatus": {
"oneOf": [
{
"enum": [
"NonTaxed",
"Inclusive",
"Exclusive"
],
"type": "string",
"description": "The tax status of an amount.",
"x-enumNames": [
"NonTaxed",
"Inclusive",
"Exclusive"
]
}
],
"description": "The amount tax status of the amounts in the journal.",
"example": "Inclusive"
},
"status": {
"oneOf": [
{
"enum": [
"Draft",
"Posted",
"Reversed"
],
"type": "string",
"description": "The journal status.",
"x-enumNames": [
"Draft",
"Posted",
"Reversed"
]
}
],
"description": "The status of the journal.",
"example": "Posted"
},
"journalType": {
"oneOf": [
{
"enum": [
"General",
"BankOpeningBalance",
"MoneyTransfer",
"PayRun"
],
"type": "string",
"description": "The type of journal.",
"x-enumNames": [
"General",
"BankOpeningBalance",
"MoneyTransfer",
"PayRun"
]
}
],
"description": "The type of journal.",
"example": "General"
},
"description": {
"type": "string",
"description": "Description of the journal.",
"nullable": true,
"example": "System generated bank account opening balance journal."
},
"adjustingJournal": {
"type": "boolean",
"description": "Whether this is an adjusting journal.",
"example": false
},
"transactionLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"linkId": {
"type": "string",
"description": "The link's unique id.",
"example": "EST-8cc23593-4790-4f56-b2a1-92396b3f2aaf"
},
"transactionType": {
"oneOf": [
{
"enum": [
"Estimate",
"Expense",
"Timesheet",
"Receipt",
"CreditNote",
"Payment",
"Invoice",
"Journal",
"Bill",
"PayRun",
"ReversedJournal",
"ReversalJournal",
"BankPayment",
"SupplierCreditNote"
],
"type": "string",
"description": "Type of transaction linked to an invoice or bill.",
"x-enumNames": [
"Estimate",
"Expense",
"Timesheet",
"Receipt",
"CreditNote",
"Payment",
"Invoice",
"Journal",
"Bill",
"PayRun",
"ReversedJournal",
"ReversalJournal",
"BankPayment",
"SupplierCreditNote"
]
}
],
"description": "The type of linked transaction.",
"example": "Estimate"
},
"transactionId": {
"type": "string",
"description": "The unique id of the linked transaction.",
"format": "guid",
"example": "8cc23593-4790-4f56-b2a1-92396b3f2aaf"
},
"transactionNumber": {
"type": "string",
"description": "The transaction number of the linked transaction.",
"nullable": true,
"example": "EST0028"
},
"transactionDate": {
"type": "string",
"description": "The transaction's date.",
"format": "date-time",
"nullable": true,
"example": "2020-02-06T12:00:00Z"
},
"transactionReference": {
"type": "string",
"description": "The transaction's reference.",
"nullable": true,
"example": "Ref 1234"
},
"transactionAmount": {
"type": "number",
"description": "The total amount of the transaction. ",
"format": "decimal",
"nullable": true,
"example": 1000.0
},
"href": {
"type": "string",
"description": "The URL to use to retrieve the linked transaction.",
"nullable": true,
"example": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/estimates/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
}
},
"additionalProperties": false,
"description": "A transaction linked to another transaction."
},
"description": "Details of transactions (e.g. pay runs) that are linked to the journal.",
"nullable": true,
"example": [
{
"linkId": "JNL-8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd",
"transactionType": "ReversalJournal",
"transactionId": "8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd",
"transactionNumber": "00104R",
"transactionDate": "2022-01-20",
"transactionReference": "Reversal of GJE 00104 Created on 20 Jan 2022",
"transactionAmount": null,
"href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/journals/8ea0e933-3db2-40d5-a0b8-4a7ca8e163bd"
}
]
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lineId": {
"type": "string",
"description": "The journal line item's unique id.",
"format": "guid",
"example": "8f991c2c-b33d-41e1-aa2e-0641b59c13fc"
},
"reconciliationStatus": {
"oneOf": [
{
"enum": [
"Uncleared",
"Cleared",
"Reconciled"
],
"type": "string",
"description": "Reconciliation status.",
"x-enumNames": [
"Uncleared",
"Cleared",
"Reconciled"
]
}
],
"description": "The reconciliation status.",
"example": "Cleared"
},
"transactionType": {
"oneOf": [
{
"enum": [
"Sale",
"Purchase",
"Transfer"
],
"type": "string",
"description": "The type of transaction.",
"x-enumNames": [
"Sale",
"Purchase",
"Transfer"
]
}
],
"description": "The type of transaction.",
"nullable": true,
"example": "Sale"
},
"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": {
"id": "96e28fa3-89a7-4b40-815e-8c7b18e7eb71",
"name": "Sales"
}
},
"debit": {
"type": "number",
"description": "The debit amount.",
"format": "decimal",
"nullable": true,
"example": 200.0
},
"credit": {
"type": "number",
"description": "The credit amount.",
"format": "decimal",
"nullable": true,
"example": null
},
"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": "ccccaaa6-c181-496e-89b6-cdb96c7d7e55",
"name": "GST",
"rate": 10
}
},
"taxAmount": {
"type": "number",
"description": "The tax amount.",
"format": "decimal",
"nullable": true,
"example": 20.0
},
"taxIsModified": {
"type": "boolean",
"description": "Whether the tax amount has been modified.",
"example": false
},
"notes": {
"type": "string",
"description": "Notes.",
"nullable": true,
"example": "Notes about the line."
},
"entity": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
},
"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 type of entity.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to an entity used in a journal.",
"example": {
"id": "aa52ba6a-6318-4586-b929-83c46ec7b15c",
"name": "Customer",
"entityTypes": {
"isCustomer": true,
"isSupplier": false,
"isEmployee": false,
"isSuperfund": false
}
}
}
],
"description": "The entity (customer/supplier/superfund/employee).",
"nullable": true
},
"project": {
"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 project.",
"example": {
"id": "40f4ab48-4be1-4b47-842a-dc9b3973b3fd",
"name": "Project A:Project B"
}
}
],
"description": "The project.",
"nullable": true
},
"classification": {
"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 classification.",
"example": {
"id": "9c533a04-8580-4513-ab12-129d99e53b5f",
"name": "My classification"
}
}
],
"description": "The classification.",
"nullable": true
},
"transactionLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"linkId": {
"type": "string",
"description": "The link's unique id.",
"example": "EST-8cc23593-4790-4f56-b2a1-92396b3f2aaf"
},
"transactionType": {
"oneOf": [
{
"enum": [
"Estimate",
"Expense",
"Timesheet",
"Receipt",
"CreditNote",
"Payment",
"Invoice",
"Journal",
"Bill",
"PayRun",
"ReversedJournal",
"ReversalJournal",
"BankPayment",
"SupplierCreditNote"
],
"type": "string",
"description": "Type of transaction linked to an invoice or bill.",
"x-enumNames": [
"Estimate",
"Expense",
"Timesheet",
"Receipt",
"CreditNote",
"Payment",
"Invoice",
"Journal",
"Bill",
"PayRun",
"ReversedJournal",
"ReversalJournal",
"BankPayment",
"SupplierCreditNote"
]
}
],
"description": "The type of linked transaction.",
"example": "Estimate"
},
"transactionId": {
"type": "string",
"description": "The unique id of the linked transaction.",
"format": "guid",
"example": "8cc23593-4790-4f56-b2a1-92396b3f2aaf"
},
"transactionNumber": {
"type": "string",
"description": "The transaction number of the linked transaction.",
"nullable": true,
"example": "EST0028"
},
"transactionDate": {
"type": "string",
"description": "The transaction's date.",
"format": "date-time",
"nullable": true,
"example": "2020-02-06T12:00:00Z"
},
"transactionReference": {
"type": "string",
"description": "The transaction's reference.",
"nullable": true,
"example": "Ref 1234"
},
"transactionAmount": {
"type": "number",
"description": "The total amount of the transaction. ",
"format": "decimal",
"nullable": true,
"example": 1000.0
},
"href": {
"type": "string",
"description": "The URL to use to retrieve the linked transaction.",
"nullable": true,
"example": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/estimates/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
}
},
"additionalProperties": false,
"description": "A transaction linked to another transaction."
},
"description": "Details of transactions (e.g. invoices, bills etc.) that are linked to the journal's line items.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Details of a journal line item."
},
"description": "The individual items that make up the journal.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Details of a journal."
}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 journal.
Representations
{
"message": "User does not have permission to access this resource.",
"code": 403
}{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "User does not have permission to access this resource."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 403
}
},
"additionalProperties": false,
"description": "Response sent when a 403 Forbidden error occurs."
}404 Not Found
The specified book or journal 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}/journals/{journalId}"
-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}/journals/{journalId}?" + 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}/journals/{journalId}");
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}/journals/{journalId}?" + $.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}/journals/{journalId}";
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}/journals/{journalId}');
$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}/journals/{journalId}?%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}/journals/{journalId}?%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}/journals/{journalId}')
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