Table of Contents

Hosted API - 16 Apr 2019

"FileName" enhancement

We've released an  updated version of Hosted API which includes enhanced FileName object that you use in each of your Hosted API calls.

 

Previously, for any shared folder, you had to pass the truncated file path. From now on, you can also send the full path of the file, along with the previous truncated file path.

 

Hosted API now accepts both truncated and full file path. That means your existing integrations will not fail. However, we suggest you to update your documentation to include the full file path instructions as  it will make it easier for your users to connect your app with Reckon Accounts Hosted than truncating the shared folder path.

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. Go to File > Audit Company file (you need to be in single user mode, you can switch from File > switch to single user mode)

 

  • File is saved under Q Drive:
    • "FileName": "Q:\{filename}"
    • Example: "FileName": "Q:\My Company file.QBW"
  • File is under Upload folder of Q Drive:
    • "FileName": "Q:\Upload\{filename}"
    • Example: "FileName": "Q:\Upload\My Company file.QBW"
  • File is under shared folder of Q Drive:
    • FileName: "\\{SharedFolderLocation}\{FolderName}\{filename}"
    • Example: "\\Rah-fss-11-ap2a\123-456789-MYCOMPANYFILE\My Company File.QBW" 

 

 

 

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.

In Reckon Accounts Hosted 2019 R2, you can now view and copy the file path.

  1. Open your company file
  2. Press Ctrl and number 1 at the same time on your keyboard and Product Information window will show up
  3. You will find the file location under File Information section. You can copy it to your clipboard and then paste it in your third party application

 

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.

Example of a payload

 {
     "FileName":"\\\\rah-fss-11-ap2a\\0123456-321000-api\\api.qbw",
     "Operation":"<?xml version=\"1.0\"?>
     <?qbxml version=\"6.1\"?>
     <QBXML>
     <QBXMLMsgsRq onError=\"continueOnError\">
     <CompanyQueryRq />
     </QBXMLMsgsRq>
  </QBXML>",
  "UserName":"MyUserName",
  "Password":"MyPassword",
  "CountryVersion": "2019.R2.AU"
 }

How did we do?

Hosted API - 10 March 2020

Hosted API - 26 Feb 2019

Related Articles

Hosted API - 26 Feb 2019
Hosted API - 10 March 2020
Authentication - Hosted API
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)