Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Gets the payroll detail report.
Get the payroll detail report.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/reports/payrollDetail
Get the report as, for example, a PDF using a query string parameter.
GET /5af6572c-9771-4b86-995d-3374d3bc683c/reports/payrollDetail?format=PDF
The following formats can be used:
JSONPDFXLSXRTFCSVHTML
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/payrollDetail
The following Accept header values can be used:
application/jsonapplication/pdfapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetapplication/rtftext/csvtext/html
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
Request body
The report parameters.
Responses
200 OK
The report.
Representations
{
"data": {
"payRuns": [
{
"payRun": {
"id": "c996eb31-179c-46f8-8215-76135030d1b4",
"name": "Unscheduled 26/04/2021"
},
"paymentDate": "2022-01-10T12:00:00Z",
"employees": [
{
"employee": {
"id": "f757807e-a294-494e-81c9-2b2bb9fa1d37",
"name": "Joe Bloggs"
},
"totalTaxableEarnings": 3870.27,
"paygTax": 1256.0,
"netPay": 2571.07,
"taxableItems": [
{
"name": "Salary",
"dates": "03/01/2022 - 09/01/2022",
"quantity": 37.5,
"rate": 27.54,
"amount": 1032.75,
"customer": "Customer A",
"project": "Project A"
}
],
"nonTaxableItems": [
{
"name": "Salary",
"dates": "03/01/2022 - 09/01/2022",
"quantity": 37.5,
"rate": 27.54,
"amount": 1032.75,
"customer": "Customer A",
"project": "Project A"
}
],
"companyItems": [
{
"name": "Super guarantee",
"dates": null,
"quantity": null,
"rate": 0.1,
"amount": -197.6,
"customer": null,
"project": null
}
]
}
]
}
]
},
"metaData": {
"id": "b5dd1bd6-18f7-45ec-92a7-d32aa9d8724e",
"reportName": "Report",
"bookName": "My book.",
"companyName": "My company.",
"period": "SpecifiedDates",
"fromDate": "2021-01-01T12:00:00Z",
"toDate": "2021-12-31T12:00:00Z",
"columns": [
"Dates",
"Customer"
]
},
"message": "Additional information."
}{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"type": "object",
"properties": {
"payRuns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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 pay run."
},
"paymentDate": {
"type": "string",
"description": "The date of the pay run payment.",
"format": "date-time",
"example": "2022-01-10T12:00:00Z"
},
"employees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"employee": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
},
"incompleteData": {
"type": "boolean",
"description": "The incomplete data flag.",
"example": "false"
}
},
"additionalProperties": false,
"description": "Reference to an employee.",
"example": {
"id": "f757807e-a294-494e-81c9-2b2bb9fa1d37",
"name": "Joe Bloggs"
}
}
],
"description": "The employee."
},
"totalTaxableEarnings": {
"type": "number",
"description": "Total taxable earnings.",
"format": "decimal",
"nullable": true,
"example": 3870.27
},
"paygTax": {
"type": "number",
"description": "Total PAYG tax withheld.",
"format": "decimal",
"nullable": true,
"example": 1256.0
},
"netPay": {
"type": "number",
"description": "Net pay.",
"format": "decimal",
"nullable": true,
"example": 2571.07
},
"taxableItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The item's name.",
"example": "Salary"
},
"dates": {
"type": "string",
"description": "Date range for this item.",
"nullable": true,
"example": "03/01/2022 - 09/01/2022"
},
"quantity": {
"type": "number",
"description": "The quantity (e.g. number of hours worked).",
"format": "decimal",
"nullable": true,
"example": 37.5
},
"rate": {
"type": "number",
"description": "The rate (e.g. pay per hour).",
"format": "decimal",
"nullable": true,
"example": 27.54
},
"amount": {
"type": "number",
"description": "The total amount (e.g. Quantity x Rate).",
"format": "decimal",
"example": 1032.75
},
"customer": {
"type": "string",
"description": "The customer's name.",
"nullable": true,
"example": "Customer A"
},
"project": {
"type": "string",
"description": "The project's name.",
"nullable": true,
"example": "Project A"
}
},
"additionalProperties": false,
"description": "Payroll Detail report - details of a transaction."
},
"description": "All taxable pay items.",
"nullable": true
},
"nonTaxableItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The item's name.",
"example": "Salary"
},
"dates": {
"type": "string",
"description": "Date range for this item.",
"nullable": true,
"example": "03/01/2022 - 09/01/2022"
},
"quantity": {
"type": "number",
"description": "The quantity (e.g. number of hours worked).",
"format": "decimal",
"nullable": true,
"example": 37.5
},
"rate": {
"type": "number",
"description": "The rate (e.g. pay per hour).",
"format": "decimal",
"nullable": true,
"example": 27.54
},
"amount": {
"type": "number",
"description": "The total amount (e.g. Quantity x Rate).",
"format": "decimal",
"example": 1032.75
},
"customer": {
"type": "string",
"description": "The customer's name.",
"nullable": true,
"example": "Customer A"
},
"project": {
"type": "string",
"description": "The project's name.",
"nullable": true,
"example": "Project A"
}
},
"additionalProperties": false,
"description": "Payroll Detail report - details of a transaction."
},
"description": "All non-taxable pay items.",
"nullable": true
},
"companyItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The item's name.",
"example": "Salary"
},
"dates": {
"type": "string",
"description": "Date range for this item.",
"nullable": true,
"example": "03/01/2022 - 09/01/2022"
},
"quantity": {
"type": "number",
"description": "The quantity (e.g. number of hours worked).",
"format": "decimal",
"nullable": true,
"example": 37.5
},
"rate": {
"type": "number",
"description": "The rate (e.g. pay per hour).",
"format": "decimal",
"nullable": true,
"example": 27.54
},
"amount": {
"type": "number",
"description": "The total amount (e.g. Quantity x Rate).",
"format": "decimal",
"example": 1032.75
},
"customer": {
"type": "string",
"description": "The customer's name.",
"nullable": true,
"example": "Customer A"
},
"project": {
"type": "string",
"description": "The project's name.",
"nullable": true,
"example": "Project A"
}
},
"additionalProperties": false,
"description": "Payroll Detail report - details of a transaction."
},
"description": "All company pay items.",
"nullable": true,
"example": [
{
"name": "Super guarantee",
"dates": null,
"quantity": null,
"rate": 0.1,
"amount": -197.6,
"customer": null,
"project": null
}
]
}
},
"additionalProperties": false,
"description": "Payroll Detail report - details of an employee."
},
"description": "Employees included in the pay run."
}
},
"additionalProperties": false,
"description": "Payroll Detail report - details of a pay run."
},
"description": "Payroll Detail report payruns."
}
},
"additionalProperties": false,
"description": "Payroll Detail report details. "
}
],
"description": "The report's data.",
"nullable": true
},
"metaData": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The report's unique id.",
"format": "guid",
"example": "b5dd1bd6-18f7-45ec-92a7-d32aa9d8724e"
},
"reportName": {
"type": "string",
"description": "The report's name.",
"example": "Report"
},
"bookName": {
"type": "string",
"description": "The book's name.",
"example": "My book."
},
"companyName": {
"type": "string",
"description": "The company's name.",
"nullable": true,
"example": "My company."
},
"period": {
"oneOf": [
{
"enum": [
"AllDates",
"SpecifiedDates"
],
"type": "string",
"description": "Periods that can be used for the Payroll Detail report.",
"x-enumNames": [
"AllDates",
"SpecifiedDates"
]
}
],
"description": "The period.",
"example": "SpecifiedDates"
},
"fromDate": {
"type": "string",
"description": "The 'from' date for the report.",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T12:00:00Z"
},
"toDate": {
"type": "string",
"description": "The 'to' date for the report.",
"format": "date-time",
"nullable": true,
"example": "2021-12-31T12:00:00Z"
},
"columns": {
"type": "array",
"items": {
"enum": [
"Dates",
"Quantity",
"Rate",
"Customer",
"Project"
],
"type": "string",
"description": "Payroll Detail Report columns.",
"x-enumNames": [
"Dates",
"Quantity",
"Rate",
"Customer",
"Project"
]
},
"description": "The list of requested report columns.",
"nullable": true,
"example": [
"Dates",
"Customer"
]
}
},
"additionalProperties": false,
"description": "Meta data for the Payroll Detail report."
}
],
"description": "Data about the report.",
"nullable": true
},
"message": {
"type": "string",
"description": "A message that might contain warnings or additional information about the report contents.",
"nullable": true,
"example": "Additional information."
}
},
"additionalProperties": false,
"description": "The Payroll Detail 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 GET "https://api.reckon.com/r1/v2/{bookId}/reports/payrollDetail?format={string}&download=true"
-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/payrollDetail?" + 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}/reports/payrollDetail");
builder.setParameter("format", "{string}");
builder.setParameter("download", "true");
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
"format": "{string}",
"download": "true",
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/reports/payrollDetail?" + $.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}/reports/payrollDetail";
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:@"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}/reports/payrollDetail');
$url = $request->getUrl();
$headers = array(
// Request headers
'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_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
'format': '{string}',
'download': 'true',
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/reports/payrollDetail?%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
'format': '{string}',
'download': 'true',
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/reports/payrollDetail?%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/payrollDetail')
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::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