Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of superstream batches.

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

Get a list of superstream batches for the specified book.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams?select=id,fromDate,toDate

Filter the results to return just the superstreams batches you want. Find out more about filtering.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/superstreams?filter=description eq "July"

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?orderby=description asc

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

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": [
    {
      "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
      "fromDate": "2020-07-01T12:00:00Z",
      "toDate": "2020-07-31T12:00:00Z",
      "description": "Super payments July 01 - July 31",
      "status": "LODGED",
      "lodgedDate": "2022-08-01T12:00:00Z",
      "totalAmount": 2500.0,
      "lineItems": [
        {
          "payrunSuperLineId": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
          "payrun": {
            "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
            "name": "Scheduled Payrun July 01 - July 31"
          },
          "paymentDate": "2020-08-01T12:00:00Z",
          "employee": {
            "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
            "name": "Mel Bourne",
            "firstName": "Mel",
            "lastName": "Bourne"
          },
          "superfund": {
            "id": "e7e3ba02-05e2-4bea-9348-85876c9952ba",
            "name": "Mainland Superfund"
          },
          "superType": "SuperGuarantee",
          "superFundProvider": {
            "id": "013c9f7c-54ea-4301-95ac-2c3db90cb40f",
            "name": "BT Lifetime Super"
          },
          "superFundProviderProduct": {
            "id": "d05520ec-4aec-45cd-8c7f-a06dc3dbc1c7",
            "name": "BT Lifetime - Flexible Pension"
          },
          "memberNumber": "M838398",
          "rateAmount": 20.0,
          "ratePercent": 10.0,
          "amount": 250.0,
          "incompleteData": "False"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The supertreams Id.",
            "format": "guid",
            "example": "e7e3ba02-05e2-4bea-9348-85876c9952ba"
          },
          "fromDate": {
            "type": "string",
            "description": "The date range start. ",
            "format": "date-time",
            "example": "2020-07-01T12:00:00Z"
          },
          "toDate": {
            "type": "string",
            "description": "The date range end. ",
            "format": "date-time",
            "example": "2020-07-31T12:00:00Z"
          },
          "description": {
            "type": "string",
            "description": "The description of the supestream batch.",
            "nullable": true,
            "example": "Super payments July 01 - July 31"
          },
          "status": {
            "oneOf": [
              {
                "enum": [
                  "Draft",
                  "Lodged"
                ],
                "type": "string",
                "description": "",
                "x-enumNames": [
                  "Draft",
                  "Lodged"
                ]
              }
            ],
            "description": "The status of the superstream.",
            "example": "LODGED"
          },
          "lodgedDate": {
            "type": "string",
            "description": "The date the superstream was lodged. ",
            "format": "date-time",
            "nullable": true,
            "example": "2022-08-01T12:00:00Z"
          },
          "totalAmount": {
            "type": "number",
            "description": "The total amount of super paid for all line items. ",
            "format": "decimal",
            "example": 2500.0
          },
          "lineItems": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "payrunSuperLineId": {
                  "type": "string",
                  "description": "The line item's unique id.",
                  "format": "guid",
                  "example": "e7e3ba02-05e2-4bea-9348-85876c9952ba"
                },
                "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"
                  }
                },
                "paymentDate": {
                  "type": "string",
                  "description": "The date the superfund was paid. ",
                  "format": "date-time",
                  "nullable": true,
                  "example": "2020-08-01T12:00:00Z"
                },
                "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"
                  }
                },
                "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"
                  }
                },
                "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"
                },
                "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 the superfund provider.",
                  "nullable": true,
                  "example": {
                    "id": "013c9f7c-54ea-4301-95ac-2c3db90cb40f",
                    "name": "BT Lifetime Super"
                  }
                },
                "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"
                  }
                },
                "memberNumber": {
                  "type": "string",
                  "description": "The members number from the superfund.",
                  "nullable": true,
                  "example": "M838398"
                },
                "rateAmount": {
                  "type": "number",
                  "description": "The rate in dollar format if used. ",
                  "format": "decimal",
                  "example": 20.0
                },
                "ratePercent": {
                  "type": "number",
                  "description": "The rate in percent format if used. ",
                  "format": "decimal",
                  "example": 10.0
                },
                "amount": {
                  "type": "number",
                  "description": "The amount of super payment made for this line item. ",
                  "format": "decimal",
                  "example": 250.0
                },
                "incompleteData": {
                  "type": "boolean",
                  "description": "The isDirty flag for the superstream line item. ",
                  "example": "False"
                }
              },
              "additionalProperties": false,
              "description": "Lineitems of a superstream."
            },
            "description": "The lineitems of the superstream.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A superstream."
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of superstreams."
}

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

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"
-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}/superstreams?" + 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");


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

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