Table of Contents

Hosted API Troubleshooting Articles

This page will be updated regularly with new/updated topics.

I get "401 Unauthorised" response when I send a query to a company files although I can get an appropriate token

You get this error if you've used your Hosted Account's username to obtain your token. For Reckon Accounts Hosted, you will need to login with your UserID (example: 1234567-1). Although you can login to the Hosted application using your Username, you will need to use your UserId to access Hosted via API.

 

Response:

Error Status: 401 Unauthorised
Message: ""

 

What should I enter in "FileName" (or File Path) object in my payload?

In Reckon Account Hosted API calls, you will need to pass the File Path in each of your call. File Path is where you define the exact location of the company file which you want to connect to send your payload to.

 

In Reckon Accounts Hosted, you can save your company file in below locations:

  1. Just under your own Q drive
  2. Under a regular folder in your Q drive (for example: Upload folder)
  3. Under a folder that's shared with other users (Control Panel > Share your company file)

 

To obtain the file location of a company file:

  1. Login to Reckon Accounts Hosted application
  2. Open the company file
  3. Press Ctrl and number 1 at the same time on your keyboard and Product Information window will show up
  4. You will find the file location under File Information section. Your user should be able to copy it and then paste it in your application
    1. File is saved under Q Drive:
      "FileLocation": "Q:\{filename}"
      Example: "FileLocation": "Q:\My Company file.QBW"
    2. File is under Upload folder of Q Drive:
      "FileLocation": "Q:\Upload{filename}"
      Example: "FileLocation": "Q:\Upload\My Company file.QBW"
    3. File is under shared folder of Q Drive:
      "FileLocation": "\{SharedFolderLocation}{FolderName}{filename}"
      Example: "\Rah-fss-11-ap2a123-456789-MYCOMPANYFILEMy Company File.QBW" 
    On 16/04/2019, we released an updated FileLocation object which can now handle full path of a shared folder, as well as the truncated FileLocation. 
Depending on the programming language you use, you might need to escape the slashes. Example: the format in your code might need to be as: \\SharedFolderLocation\FolderName\File Name.QBW. Some developers add the slashes automatically in their code but in the app's UI, asks the user to enter the file path as it's shown within Reckon Accounts Hosted Application UI.

 

Why do I get "Error accessing your Reckon Accounts company file. The user account used to connect is either logged in to your company file already, or the username or password details are wrong. Please resolve before trying again."?

 

You will get this error if the user details that you're using in your payload  is already logged in to the file via the Hosted application UI, OR the username/password of the company file is wrong. Remember that it's case-sensitive. Also, ensure that the file is in multi-user mode (in Reckon Accounts Hosted, go to File > Switch to multi-user mode).

You can setup Users (including password) and their roles from Company > Users > Set Up Users and Roles... > Double click on a user to edit their details (i.e. change username/password) or click New to add a new user and set a password.

  

Response:

Error Status: 400 Bad Request

Message: "Error accessing your Reckon Accounts company file. The user account used to connect is either logged in to your company file already, or the username or password details are wrong. Please resolve before trying again."

Is there any size limit of the payload that I send? I get a 500 status code in response if my payload's size is 5MB or more 

Yes. The payload size cannot be 5MB or more. Your payload's size has to be 4.9MB or less, including header and body. Otherwise, you'll receive a 500 response.

However, this limit doesn't apply to the response body from the query you requested.

For example: if you send a query to get Invoices created between 1st January 2019 and 30th April 2019 and the response size is more than 5MB, you will get the complete data in the response, since the limit applies to the payload you send, not the response body of the API query result.

 

Response:

 Error Status: 500 Internal Server Error
 Message: "Server error"

Why do I get "401 Access denied due to missing subscription key..." for every payload I send?

Subscription keys will be made mandatory soon. When it is mandatory, it has to be added in each call that you send to Reckon Accounts Hosted/Reckon One API. Click here to read the instructions on how to send subscription keys. We recommend our Developer Partners to start using it if you are not sending it as yet so that your calls will not get blocked once the it is mandatory to send they subscription key.

Response:

 {
    "statusCode": 401,
    "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."

 }

How do I use CountryVersion effectively without hard-coding it?  

To connect to a Hosted company file, you will need to pass the appropriate value in the CountryVersion object. Every Hosted product version comes with it's own CountryVersion value.

We recommend you to use a drop-down menu to show the CountryVersion to your users and user Support Versions endpoint to populate them.

To dynamically show the available Hosted application versions that is easier for your users to understand, you can:

  • Show the drop-down menu options by using {Country} {Version}. For example: Australia 2019.R2
  • Save the chosen option's CountryVersion value. For the above example, it would be 2019.R2.AU

In this way, not only you can connect to the new version of Hosted application without making any code changes, you can also connect to NZ version of Hosted application and link your app with NZ users.

Example of Get Supported Version endpoint response:

[
     {
         "CountryVersion": "2019.R1.NZ",
         "Country": "New Zealand",
         "Version": "2019.R1",
         "Description": null,
         "EndDate": null

     },

     {
         "CountryVersion": "2019.R2.AU",
         "Country": "Australia",
         "Version": "2019.R2",
         "Description": null,
         "EndDate": null
     }​

 ]

Why do I get "File access authorisation failed for RAH UserID. Access to requested file is denied" error when I want to access my Hosted Company file via API?

You will get this error if you use your Username instead of UserID when you login via Reckon Identity Server to get your token. Although you can login to Hosted application using your Username, however, to login to Hosted via API, you will need to use your UserID.

UserIDs are usually in this format: #######-#. For example: 1234567-1.

Where do I find my RA Hosted UserID?

To authorise a third-party application to integrate with RA Hosted you must enter your UserID (format 123456-1) when requested. Username is not currently supported for RA Hosted integrations.

You can find your UserId by following the steps below:

  1. Log in to the Hosted dashboard.
    1. RA Hosted AU link
    2. RA Hosted NZ link
  2. Click on CONTROL PANEL
  3. Click Manage Users
  4. Your UserID is in the blue colour with a link. Clicking the link shows the details of the user account
  5. Copy the UserID from here or write it down.
  6. When you are requested to SIgn In and authorise the third-party application, please ensure you use this UserID in the Username/UserID text box

 

How did we do?

Data File Maintenance Tips & Tricks​

Related Articles

Hosted API - 16 Apr 2019
Authentication - Hosted API
FAQ - Hosted API
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)