Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of unlinked super transactions for a super stream batch.

See here for details of filtering, sorting and selecting. This list is not paginated.

Get a list of unlinked super transactions for the specified super stream batch.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams/unlinkedsupertransactions?fromDate=2022-05-01&toDate=2022-06-30

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams/unlinkedsupertransactions?fromDate=2022-05-01&toDate=2022-06-30&select=payrunSuperLineId

Filter the results to return just the unlinked super transactions of a super stream batch you want. Find out more about filtering.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams/unlinkedsupertransactions?fromDate=2022-05-01&toDate=2022-06-30&filter=superType eq "SuperGuarantee"

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams/unlinkedsupertransactions?fromDate=2022-05-01&toDate=2022-06-30&orderby=fromDate asc

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 range start.

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). The date range end.

  • (optional)
    integer

    Format - int32. The page to retrieve.

  • (optional)
    integer

    Format - int32. The number of unlinked super transactions per page.

Request headers

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

Request body

Responses

200 OK

A list of superstreams.

Representations

{
  "list": [
    {
      "payrunSuperLineId": "b7e3ba07-05e2-4bea-9348-85876c9952ba",
      "superType": "SuperGuarantee",
      "payrun": {
        "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
        "name": "Scheduled Payrun July 01 - July 31"
      },
      "employee": {
        "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
        "name": "Mel Bourne",
        "firstName": "Mel",
        "lastName": "Bourne",
        "incompleteData": true
      },
      "superFundProviderProduct": {
        "id": "d05520ec-4aec-45cd-8c7f-a06dc3dbc1c7",
        "name": "BT Lifetime - Flexible Pension"
      },
      "superfund": {
        "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
        "name": "Mainland Superfund",
        "businessNumber1": "18001234",
        "incompleteData": true
      },
      "superFundProvider": {
        "id": "013c9f7c-54ea-4301-95ac-2c3db90cb40f",
        "name": "BT Lifetime Super"
      }
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "payrunSuperLineId": {
            "type": "string",
            "description": "The payrun superline id.",
            "format": "guid",
            "example": "b7e3ba07-05e2-4bea-9348-85876c9952ba"
          },
          "superType": {
            "oneOf": [
              {
                "enum": [
                  "SuperGuarantee",
                  "EmployerAdditional",
                  "Productivity",
                  "CollectiveAgreement",
                  "SalarySacrifice",
                  "MemberVoluntary",
                  "SpouseDeduction"
                ],
                "type": "string",
                "description": "The super type enum.",
                "x-enumNames": [
                  "SuperGuarantee",
                  "EmployerAdditional",
                  "Productivity",
                  "CollectiveAgreement",
                  "SalarySacrifice",
                  "MemberVoluntary",
                  "SpouseDeduction"
                ]
              }
            ],
            "description": "The super type.",
            "example": "SuperGuarantee"
          },
          "payrun": {
            "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 pay run.",
                "example": {
                  "id": "c996eb31-179c-46f8-8215-76135030d1b4",
                  "name": "Unscheduled 26/04/2021"
                }
              }
            ],
            "description": "The name and unique id of the payrun that includes the superfund details. ",
            "nullable": true,
            "example": {
              "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
              "name": "Scheduled Payrun July 01 - July 31"
            }
          },
          "employee": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Id of an employee.",
                    "format": "guid",
                    "example": "21ddbc6c-0840-48b2-ac59-7dc8f2bf2e34"
                  },
                  "name": {
                    "type": "string",
                    "description": "Name of an employee.",
                    "example": "John Smith"
                  },
                  "firstName": {
                    "type": "string",
                    "description": "First name of an employee.",
                    "example": "John"
                  },
                  "lastName": {
                    "type": "string",
                    "description": "Last namne of an employee.",
                    "example": "Smith"
                  },
                  "incompleteData": {
                    "type": "boolean",
                    "description": "The incomplete data flag.",
                    "example": "false"
                  }
                },
                "additionalProperties": false,
                "description": "An employee linked to a superstream."
              }
            ],
            "description": "The details of the employee in the superstream. ",
            "nullable": true,
            "example": {
              "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
              "name": "Mel Bourne",
              "firstName": "Mel",
              "lastName": "Bourne",
              "incompleteData": true
            }
          },
          "superFundProviderProduct": {
            "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 super fund provider product.",
                "example": {
                  "id": "c4e3cc74-8e81-4ae0-90d2-324d1e1a4479",
                  "name": "CARE Super Pension"
                }
              }
            ],
            "description": "The name and unique id of the product of the super fund provider. ",
            "nullable": true,
            "example": {
              "id": "d05520ec-4aec-45cd-8c7f-a06dc3dbc1c7",
              "name": "BT Lifetime - Flexible Pension"
            }
          },
          "superfund": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "The unique id.",
                    "format": "guid",
                    "nullable": true
                  },
                  "name": {
                    "type": "string",
                    "description": "The unique name.",
                    "nullable": true
                  },
                  "businessNumber1": {
                    "type": "string",
                    "description": "The business number 1.",
                    "nullable": true,
                    "example": "18001234"
                  },
                  "incompleteData": {
                    "type": "boolean",
                    "description": "The incomplete data flag.",
                    "example": "false"
                  }
                },
                "additionalProperties": false,
                "description": "Reference to a super fund.",
                "example": {
                  "id": "c4e3cc74-8e81-4ae0-90d2-324d1e1a4479",
                  "name": "APRA Superfund"
                }
              }
            ],
            "description": "The name and unique id of the company superfund organisation. ",
            "nullable": true,
            "example": {
              "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
              "name": "Mainland Superfund",
              "businessNumber1": "18001234",
              "incompleteData": true
            }
          },
          "superFundProvider": {
            "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 super fund provider.",
                "example": {
                  "id": "c4e3cc74-8e81-4ae0-90d2-324d1e1a4479",
                  "name": "APRA Superannuation Company"
                }
              }
            ],
            "description": "The name and unique id of the superfund provider.",
            "nullable": true,
            "example": {
              "id": "013c9f7c-54ea-4301-95ac-2c3db90cb40f",
              "name": "BT Lifetime Super"
            }
          }
        },
        "additionalProperties": false,
        "description": "The superstream unlinked payrun."
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of a superstream unlinked payruns."
}

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 unlinked payruns.

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

            builder.setParameter("fromDate", "{string}");
            builder.setParameter("toDate", "{string}");
            builder.setParameter("page", "1");
            builder.setParameter("perPage", "0");

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

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

$request->setHeader($headers);

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

$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
    'fromDate': '{string}',
    'toDate': '{string}',
    'page': '1',
    'perPage': '0',
})

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

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

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

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