Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Updates selected fields of a book's payroll settings.
Patch a book's payroll settings.
Note: The Content-Type
header must be application/merge-patch+json
.
PATCH /5af6572c-9771-4b86-995d-3374d3bc683c/settings/payroll
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
The book's payroll settings being altered.
{
"isStpV2Enabled": true,
"isPreparingForStpV2": true,
"legalContact": {
"firstName": "John",
"lastName": "Smith",
"title": "Mr"
},
"payrollSetup": {
"copyPayItemsFromPreviousPay": true,
"trackProjectCost": true,
"allowPayRatesEditInPayRuns": true,
"optionalEmailPasswordProtection": false,
"displayYTDOnPayrun": true
},
"defaultAccounts": {
"payWitholdingAmountToSupplier": true,
"expenseAccount": "Payroll Expenses:Annual Leave",
"expenseAccountForCompanySuperContributions": "296cde83-f8c3-469f-b474-4892da4dbdb5",
"liabilityAccount": "Payroll Liabilities:ABN Withholding Tax Payable",
"liabilityAccountForWithholdingAmounts": "f08af612-a854-40bc-890d-e3592ea5e167",
"supplierForWithholdingAmounts": "John Doe"
},
"defaultPayments": {
"roundToNearest": "TenCents",
"expenseAccountForRounding": "Payroll Expenses"
},
"automaticPayrollPayments": true,
"defaultBankAccounts": {
"directCreditPaymentsBankAccount": "My Bank Account",
"cashPaymentsBankAccount": "c458dee2-c152-4f5b-b6ed-bf6d7a83051b",
"superPaymentsBankAccount": "My super payment bank account"
}
}
{
"type": "object",
"properties": {
"isStpV2Enabled": {
"type": "boolean",
"description": "Indicates whether Single Touch Payroll report version 2 is enabled.",
"nullable": true
},
"isPreparingForStpV2": {
"type": "boolean",
"description": "Indicates whether the book is being prepared for Single Touch Payroll version 2.",
"nullable": true
},
"legalContact": {
"oneOf": [
{
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The first name of legal contact.",
"nullable": true,
"example": "John"
},
"lastName": {
"type": "string",
"description": "The last name of legal contact.",
"nullable": true,
"example": "Smith"
},
"title": {
"type": "string",
"description": "The legal contact's title.",
"nullable": true,
"example": "Mr"
}
},
"additionalProperties": false,
"description": "The payroll settings' legal contact details to patch."
}
],
"description": "The payroll settings' legal contact.",
"nullable": true
},
"payrollSetup": {
"oneOf": [
{
"type": "object",
"properties": {
"copyPayItemsFromPreviousPay": {
"type": "boolean",
"description": "Indicates whether the pay run copies pay items from previous pay (overrides default pay items).",
"nullable": true,
"example": true
},
"trackProjectCost": {
"type": "boolean",
"description": "Indicates whether it tracks project cost.\n ",
"nullable": true,
"example": true
},
"allowPayRatesEditInPayRuns": {
"type": "boolean",
"description": "Indicates whether it allows editing of pay rates on pay runs.",
"nullable": true,
"example": true
},
"optionalEmailPasswordProtection": {
"type": "boolean",
"description": "Indicates whether it enables password protection for emailing pay slips and payment summaries.",
"nullable": true,
"example": false
},
"displayYTDOnPayrun": {
"type": "boolean",
"description": "Indicates whether it displays YTD amounts on pay run.",
"nullable": true,
"example": true
}
},
"additionalProperties": false,
"description": "A book's payroll setup to patch."
}
],
"description": "The payroll setup details.",
"nullable": true
},
"defaultAccounts": {
"oneOf": [
{
"type": "object",
"properties": {
"payWitholdingAmountToSupplier": {
"type": "boolean",
"description": "Indicates whether pays to supplier through accounts payable.",
"nullable": true,
"example": true
},
"expenseAccount": {
"type": "string",
"description": "The expense account.",
"nullable": true,
"example": "Payroll Expenses:Annual Leave"
},
"expenseAccountForCompanySuperContributions": {
"type": "string",
"description": "The expense account for company super contributions.",
"nullable": true,
"example": "296cde83-f8c3-469f-b474-4892da4dbdb5"
},
"liabilityAccount": {
"type": "string",
"description": "The liability account.",
"nullable": true,
"example": "Payroll Liabilities:ABN Withholding Tax Payable"
},
"liabilityAccountForWithholdingAmounts": {
"type": "string",
"description": "The liability account for withholding amount.",
"nullable": true,
"example": "f08af612-a854-40bc-890d-e3592ea5e167"
},
"supplierForWithholdingAmounts": {
"type": "string",
"description": "Supplier for withholding amounts.",
"nullable": true,
"example": "John Doe"
}
},
"additionalProperties": false,
"description": "The payroll settings' default accounts to patch."
}
],
"description": "The default payroll accounts.",
"nullable": true
},
"defaultPayments": {
"oneOf": [
{
"type": "object",
"properties": {
"roundToNearest": {
"oneOf": [
{
"enum": [
"NoRounding",
"FiveCents",
"TenCents",
"FiftyCents",
"OneDollar"
],
"type": "string",
"description": "Rounding settings of payments.",
"x-enumNames": [
"NoRounding",
"FiveCents",
"TenCents",
"FiftyCents",
"OneDollar"
]
}
],
"description": "Rounding settings of payments.",
"nullable": true,
"example": "TenCents"
},
"expenseAccountForRounding": {
"type": "string",
"description": "Expense account for rounding of cash payments.",
"nullable": true,
"example": "Payroll Expenses"
}
},
"additionalProperties": false,
"description": "The details of payroll default payments to patch."
}
],
"description": "The default payroll payments.",
"nullable": true
},
"automaticPayrollPayments": {
"type": "boolean",
"description": "Indicates whether makes payroll salary and wages payments when users finish each pay run.",
"nullable": true,
"example": true
},
"defaultBankAccounts": {
"oneOf": [
{
"type": "object",
"properties": {
"directCreditPaymentsBankAccount": {
"type": "string",
"description": "The direct credit payment bank account.",
"nullable": true,
"example": "My Bank Account"
},
"cashPaymentsBankAccount": {
"type": "string",
"description": "The cash payments account.",
"nullable": true,
"example": "c458dee2-c152-4f5b-b6ed-bf6d7a83051b"
},
"superPaymentsBankAccount": {
"type": "string",
"description": "The super payment bank account.",
"nullable": true,
"example": "My super payment bank account"
}
},
"additionalProperties": false,
"description": "The details of payroll default bank accounts to patch."
}
],
"description": "The default payroll bank accounts.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A book's payroll settings to patch."
}
string
{
"type": "string",
"format": "binary",
"x-apim-inline": true
}
Responses
204 No Content
The result of the update.
400 Bad Request
The book's payroll settings could not be updated as the request contains invalid data.
Representations
{
"message": "Something went wrong.",
"code": 400,
"errorCode": "General.NotFound",
"errors": [
{
"location": "password",
"message": "The value entered is not a valid password.",
"errorCode": "General.DuplicateValue"
}
]
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Something went wrong."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 400
},
"errorCode": {
"type": "string",
"description": "The error code.",
"nullable": true,
"example": "General.NotFound"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The location/path of the source of the error.",
"nullable": true,
"example": "password"
},
"message": {
"type": "string",
"description": "The description of what was wrong at this location.",
"nullable": true,
"example": "The value entered is not a valid password."
},
"errorCode": {
"type": "string",
"description": "The error code.",
"nullable": true,
"example": "General.DuplicateValue"
}
},
"additionalProperties": false,
"description": "Details of a specific error."
},
"description": "An array of specific errors where relevant.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response sent when an error occurs."
}
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 edit book's payroll settings.
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."
}
415 Unsupported Media Type
The request must use Content-Type application/merge-patch+json
.
Representations
{
"message": "application/json is not supported. Please use content-type application/merge-patch+json.",
"code": 415
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "application/json is not supported. Please use content-type application/merge-patch+json."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 415
}
},
"additionalProperties": false,
"description": "Response sent when a 415 Unsupported media type error occurs."
}
Code samples
@ECHO OFF
curl -v -X PATCH "https://api.reckon.com/r1/v2/{bookId}/settings/payroll"
-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}");
var uri = "https://api.reckon.com/r1/v2/{bookId}/settings/payroll?" + queryString;
}
}
}
// // 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}/settings/payroll");
URI uri = builder.build();
HttpPatch request = new HttpPatch(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
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/settings/payroll?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PATCH",
// 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}/settings/payroll";
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:@"PATCH"];
// 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}/settings/payroll');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PATCH);
// 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({
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("PATCH", "/r1/v2/{bookId}/settings/payroll?%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({
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("PATCH", "/r1/v2/{bookId}/settings/payroll?%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}/settings/payroll')
request = Net::HTTP::Patch.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