Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets the super transactions report.

Get the super transactions report.

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

Get the report as, for example, a PDF using a query string parameter.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/reports/superTransactions?format=PDF

The following formats can be used:

  • PDF
  • XLSX
  • RTF
  • CSV
  • HTML

JSON is not supported for this report at this time.

Get the report as, for example, a PDF using a header instead of the query string parameter: Accept: application/pdf

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

The following Accept header values can be used:

  • application/pdf
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/rtf
  • text/csv
  • text/html

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • (optional)
    string

    The format to use, e.g. pdf.

  • (optional)
    boolean

    Whether the result is for download. If true, a ContentDisposition header will be added.

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 report parameters.

{
  "token": "asdkfasdfkjasdgfgarekjhgfu2g8378rffcbwdhjbjdhk3cfoch3c3",
  "period": "AllDates",
  "fromDate": "null",
  "toDate": "null",
  "payruns": "null",
  "employees": "null",
  "superfunds": "null",
  "orientation": "Portrait",
  "columns": "null"
}
{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "An authentication token. Note that this is not required if it is supplied via the HTTP `Authorize` header.",
      "nullable": true,
      "example": "asdkfasdfkjasdgfgarekjhgfu2g8378rffcbwdhjbjdhk3cfoch3c3"
    },
    "period": {
      "oneOf": [
        {
          "enum": [
            "AllDates",
            "SpecifiedDates"
          ],
          "type": "string",
          "description": "Periods that can be used for the Super Transactions report.",
          "x-enumNames": [
            "AllDates",
            "SpecifiedDates"
          ]
        }
      ],
      "description": "The period.",
      "default": "AllDates",
      "nullable": true,
      "example": "AllDates"
    },
    "fromDate": {
      "type": "string",
      "description": "The 'from' date for the report.\nOnly required if `period` is `SpecifiedDates`.",
      "format": "date-time",
      "default": "null",
      "nullable": true,
      "example": "2021-01-01T12:00:00Z"
    },
    "toDate": {
      "type": "string",
      "description": "The 'to' date for the report.\nOnly required if `period` is `SpecifiedDates`.",
      "format": "date-time",
      "default": "null",
      "nullable": true,
      "example": "2021-12-31T12:00:00Z"
    },
    "payruns": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "guid"
      },
      "description": "A list of pay run IDs to include in the report.\nIf omitted, all pay runs will be included.",
      "default": "null",
      "nullable": true,
      "example": [
        "a16010b7-43a0-40cc-a3de-151420659df7"
      ]
    },
    "employees": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "guid"
      },
      "description": "A list of employee IDs to include in the report.\nIf omitted, all employees will be included.",
      "default": "null",
      "nullable": true,
      "example": [
        "3e3b17cc-9071-4822-893e-9ef67dbf572c"
      ]
    },
    "superfunds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "guid"
      },
      "description": "A list of superfund IDs to include in the report.\nIf omitted, all superfunds will be included.",
      "default": "null",
      "nullable": true,
      "example": [
        "3e3b17cc-9071-4822-893e-9ef67dbf572c"
      ]
    },
    "orientation": {
      "oneOf": [
        {
          "enum": [
            "Portrait",
            "Landscape"
          ],
          "type": "string",
          "description": "The report orientation.",
          "x-enumNames": [
            "Portrait",
            "Landscape"
          ]
        }
      ],
      "description": "The report's orientation.",
      "default": "Portrait",
      "nullable": true,
      "example": "Portrait"
    },
    "columns": {
      "type": "array",
      "items": {
        "enum": [
          "PayRunName",
          "PayItem",
          "Rate",
          "MemberNumber"
        ],
        "type": "string",
        "description": "Payroll Detail Report columns.",
        "x-enumNames": [
          "PayRunName",
          "PayItem",
          "Rate",
          "MemberNumber"
        ]
      },
      "description": "A list of columns to include in the report.\nIf omitted, all columns will be returned.",
      "default": "null",
      "nullable": true,
      "example": [
        "PayRunName",
        "MemberNumber"
      ]
    }
  },
  "additionalProperties": false,
  "description": "The parameters for the Super Transactions report."
}

Responses

200 OK

The report.

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 view the report.

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}/reports/superTransactions?format={string}&download=true"
-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["format"] = "{string}";
            queryString["download"] = "true";
            var uri = "https://api.reckon.com/r1/v2/{bookId}/reports/superTransactions?" + 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}/reports/superTransactions");

            builder.setParameter("format", "{string}");
            builder.setParameter("download", "true");

            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
            "format": "{string}",
            "download": "true",
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/reports/superTransactions?" + $.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}/reports/superTransactions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"format={string}",
                         @"download=true",
                      ];
    
    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}/reports/superTransactions');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'format' => '{string}',
    'download' => 'true',
);

$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
    'format': '{string}',
    'download': 'true',
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("POST", "/r1/v2/{bookId}/reports/superTransactions?%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
    'format': '{string}',
    'download': 'true',
})

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

query = URI.encode_www_form({
    # Request parameters
    'format' => '{string}',
    'download' => 'true'
})

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