Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Updates selected fields of a book's tax settings.

Patch a book's tax settings.

Note: The Content-Type header must be application/merge-patch+json.

PATCH /5af6572c-9771-4b86-995d-3374d3bc683c/settings/tax

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

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 book's tax settings being updated.

{
  "taxRegistered": true,
  "reportingBasis": "Accrual",
  "amountTaxStatus": "Gross (Tax Inclusive)",
  "defaultSalesTaxLedgerAccount": "GST Payable:GST Collected",
  "defaultPurchasesTaxLedgerAccount": "GST Payable:GST Paid",
  "taxAmountEditable": true,
  "chooseAmountTaxStatus": true,
  "basSettings": {
    "reportingPeriodType": "Monthly",
    "simplerBAS": true,
    "amountTaxStatus": "Inclusive",
    "fbt": true,
    "ftc": true,
    "lct": true,
    "paygiPayQuarterly": true,
    "paygiCalculateUsingIncomeTimesRate": true,
    "paygw": true,
    "wet": true
  },
  "gstSettings": {
    "filingFrequency": {},
    "reportingPeriod": {},
    "returnBasis": {}
  },
  "vatSettings": {
    "registrationNumber": "string",
    "scheme": {},
    "periodGroup": {},
    "flatRateScheme": {},
    "registeredSinceDate": "string",
    "ecVatEnabled": true,
    "usePostponedVatAccounting": true
  },
  "emailSettings": {
    "bas": {
      "includeCc": true,
      "ccAddress": "ccemail@email.com",
      "includeBcc": true,
      "bccAddress": "bccemail@email.com",
      "emailSubject": "Activity Statement",
      "emailContent": "Please review the attached Activity Statement. Feel free to contact us if you have any questions."
    }
  }
}
{
  "type": "object",
  "properties": {
    "taxRegistered": {
      "type": "boolean",
      "description": "Indicates whether you registered for tax.",
      "nullable": true,
      "example": true
    },
    "reportingBasis": {
      "oneOf": [
        {
          "enum": [
            "Accrual",
            "Cash",
            "Hybrid"
          ],
          "type": "string",
          "description": "The sales figures type of tax. Hybrid is for NZ books only.",
          "x-enumNames": [
            "Accrual",
            "Cash",
            "Hybrid"
          ]
        }
      ],
      "description": "The tax reporting basis type.",
      "nullable": true,
      "example": "Accrual"
    },
    "amountTaxStatus": {
      "oneOf": [
        {
          "enum": [
            "Inclusive",
            "Exclusive"
          ],
          "type": "string",
          "description": "The sales figures type of tax.",
          "x-enumNames": [
            "Inclusive",
            "Exclusive"
          ]
        }
      ],
      "description": "Indicates whether sales figures are shown in the gross sales or the net sales.",
      "nullable": true,
      "example": "Gross (Tax Inclusive)"
    },
    "defaultSalesTaxLedgerAccount": {
      "type": "string",
      "description": "Default tax account ledger for sales.",
      "nullable": true,
      "example": "GST Payable:GST Collected"
    },
    "defaultPurchasesTaxLedgerAccount": {
      "type": "string",
      "description": "Default tax account ledger for purchases.",
      "nullable": true,
      "example": "GST Payable:GST Paid"
    },
    "taxAmountEditable": {
      "type": "boolean",
      "description": "Indicates whether allows users to edit tax amounts.",
      "nullable": true,
      "example": true
    },
    "chooseAmountTaxStatus": {
      "type": "boolean",
      "description": "Indicates whether a user can choose if amounts include or exclude tax.",
      "nullable": true,
      "example": true
    },
    "basSettings": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "reportingPeriodType": {
              "oneOf": [
                {
                  "enum": [
                    "Monthly",
                    "QuarterlyOption1GstReportQuarterly",
                    "QuarterlyOption2GstQuarterlyReportAnnually",
                    "QuarterlyOption3GstInstalmentQuarterly",
                    "Annually"
                  ],
                  "type": "string",
                  "description": "The BAS reporting period.",
                  "x-enumNames": [
                    "Monthly",
                    "QuarterlyOption1GstReportQuarterly",
                    "QuarterlyOption2GstQuarterlyReportAnnually",
                    "QuarterlyOption3GstInstalmentQuarterly",
                    "Annually"
                  ]
                }
              ],
              "description": "The BAS reporting period.",
              "example": "Monthly"
            },
            "simplerBAS": {
              "type": "boolean",
              "description": "Indicates whether its a simpler BAS. Simpler BAS is only applicable for business reporting GST on Monthly, Annual or quarterly basis (option 1: Calculate GST and report quarterly).",
              "nullable": true,
              "example": true
            },
            "amountTaxStatus": {
              "oneOf": [
                {
                  "enum": [
                    "Inclusive",
                    "Exclusive"
                  ],
                  "type": "string",
                  "description": "The sales figures type of tax.",
                  "x-enumNames": [
                    "Inclusive",
                    "Exclusive"
                  ]
                }
              ],
              "description": "Show amounts reported in BAS as inclusive or exclusive.",
              "nullable": true,
              "example": "Inclusive"
            },
            "fbt": {
              "type": "boolean",
              "description": "Indicates whether Fringe Benefits Tax (FBT) applies to the business.",
              "nullable": true,
              "example": true
            },
            "ftc": {
              "type": "boolean",
              "description": "Indicates whether Fuel Tax Credits (FTC) applies to the business.",
              "nullable": true,
              "example": true
            },
            "lct": {
              "type": "boolean",
              "description": "Indicates whether Luxury Car Tax (LCT) applies to the business.",
              "nullable": true,
              "example": true
            },
            "paygiPayQuarterly": {
              "type": "boolean",
              "description": "Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Pay PAYG instalment quarterly.",
              "nullable": true,
              "example": true
            },
            "paygiCalculateUsingIncomeTimesRate": {
              "type": "boolean",
              "description": "Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Calculate PAYG instalment using income times rate.",
              "nullable": true,
              "example": true
            },
            "paygw": {
              "type": "boolean",
              "description": "Indicates whether Pay As You Go Tax Withheld (PAYG W) applies to the business.",
              "nullable": true,
              "example": true
            },
            "wet": {
              "type": "boolean",
              "description": "Indicates whether Wine Equalisation Tax (WET) applies to the business.",
              "nullable": true,
              "example": true
            }
          },
          "additionalProperties": false,
          "description": "BAS report settings to patch."
        }
      ],
      "description": "The BAS reporting preference details.",
      "nullable": true
    },
    "gstSettings": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "filingFrequency": {
              "oneOf": [
                {
                  "enum": [
                    "Monthly",
                    "TwoMonthly",
                    "SixMonthly"
                  ],
                  "type": "string",
                  "description": "The GST filing frequency.",
                  "x-enumNames": [
                    "Monthly",
                    "TwoMonthly",
                    "SixMonthly"
                  ]
                }
              ],
              "description": "The GST filing frequency."
            },
            "reportingPeriod": {
              "oneOf": [
                {
                  "enum": [
                    "StartsFromJan",
                    "StartsFromFeb",
                    "StartsFromMar",
                    "StartsFromApr",
                    "StartsFromMay",
                    "StartsFromJun"
                  ],
                  "type": "string",
                  "description": "The GST reporting period.",
                  "x-enumNames": [
                    "StartsFromJan",
                    "StartsFromFeb",
                    "StartsFromMar",
                    "StartsFromApr",
                    "StartsFromMay",
                    "StartsFromJun"
                  ]
                }
              ],
              "description": "The GST reporting period."
            },
            "returnBasis": {
              "oneOf": [
                {
                  "enum": [
                    "CalculateGSTFromGross",
                    "CalculateGrossFromGST"
                  ],
                  "type": "string",
                  "description": "The GST return basis.",
                  "x-enumNames": [
                    "CalculateGSTFromGross",
                    "CalculateGrossFromGST"
                  ]
                }
              ],
              "description": "The GST return basis."
            }
          },
          "additionalProperties": false,
          "description": "GST report settings to patch."
        }
      ],
      "description": "The GST reporting preference details.",
      "nullable": true
    },
    "vatSettings": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "registrationNumber": {
              "type": "string",
              "description": "VAT registration number.",
              "nullable": true
            },
            "scheme": {
              "oneOf": [
                {
                  "enum": [
                    "Standard",
                    "Monthly",
                    "Annual"
                  ],
                  "type": "string",
                  "description": "HMRC VAT scheme.",
                  "x-enumNames": [
                    "Standard",
                    "Monthly",
                    "Annual"
                  ]
                }
              ],
              "description": "HMRC VAT scheme.",
              "nullable": true
            },
            "periodGroup": {
              "oneOf": [
                {
                  "enum": [
                    "MarJunSepDec",
                    "JulOctJanApr",
                    "AugNovFebMay"
                  ],
                  "type": "string",
                  "description": "VAT period ending group.",
                  "x-enumNames": [
                    "MarJunSepDec",
                    "JulOctJanApr",
                    "AugNovFebMay"
                  ]
                }
              ],
              "description": "VAT period ending group.",
              "nullable": true
            },
            "flatRateScheme": {
              "oneOf": [
                {
                  "enum": [
                    "Enabled",
                    "Disabled"
                  ],
                  "type": "string",
                  "description": "VAT flat rate scheme.",
                  "x-enumNames": [
                    "Enabled",
                    "Disabled"
                  ]
                }
              ],
              "description": "VAT flat rate scheme.",
              "nullable": true
            },
            "registeredSinceDate": {
              "type": "string",
              "description": "VAT Registered since date.",
              "format": "date-time",
              "nullable": true
            },
            "ecVatEnabled": {
              "type": "boolean",
              "description": "Activates EC VAT codes and flag on the VAT return that EC VAT is enabled.",
              "nullable": true
            },
            "usePostponedVatAccounting": {
              "type": "boolean",
              "description": "Enables Postponed VAT Accounting codes.",
              "nullable": true
            }
          },
          "additionalProperties": false,
          "description": "VAT report settings to patch."
        }
      ],
      "description": "The VAT reporting preference details.",
      "nullable": true
    },
    "emailSettings": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "bas": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "includeCc": {
                      "type": "boolean",
                      "description": "Indicates whether includes CC by default when emailing.",
                      "nullable": true,
                      "example": true
                    },
                    "ccAddress": {
                      "type": "string",
                      "description": "Default CC email address.",
                      "nullable": true,
                      "example": "ccemail@email.com"
                    },
                    "includeBcc": {
                      "type": "boolean",
                      "description": "Indicates whether includes BCC by default when emailing.",
                      "nullable": true,
                      "example": true
                    },
                    "bccAddress": {
                      "type": "string",
                      "description": "Default BCC email address.",
                      "nullable": true,
                      "example": "bccemail@email.com"
                    },
                    "emailSubject": {
                      "type": "string",
                      "description": "Default email subject.",
                      "nullable": true,
                      "example": "Activity Statement"
                    },
                    "emailContent": {
                      "type": "string",
                      "description": "Default email content.",
                      "nullable": true,
                      "example": "Please review the attached Activity Statement. Feel free to contact us if you have any questions."
                    }
                  },
                  "additionalProperties": false,
                  "description": "The email template to patch."
                }
              ],
              "description": "BAS default email settings.",
              "nullable": true
            }
          },
          "additionalProperties": false,
          "description": "The book's tax email settings to patch."
        }
      ],
      "description": "The email settings for tax.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Tax 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 tax 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 tax 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/tax"
-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/tax?" + 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/tax");


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

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