A comprehensive online accounting solution for large businesses.
Ping this endpoint to determine if the service is available.
Can also be used to "warm up" the service.
Post a QBXML request for processing
{
"FileName":"{{file_name}}",
"Operation":"<?xml version=\"1.0\"?>
<?qbxml version=\"6.1\"?>
<QBXML>
<QBXMLMsgsRq onError=\"continueOnError\">
<CompanyQueryRq />
</QBXMLMsgsRq>
</QBXML>",
"UserName":"{{file_username}}",
"Password":"{{file_password}}",
"CountryVersion": "{{country_version}}"
}
{
"FileName":"{{file_name}}",
"Operation":"<?xml version=\"1.0\"?>
<?qbxml version=\"6.1\"?>
<QBXML>
<QBXMLMsgsRq onError=\"continueOnError\">
<CompanyQueryRq />
</QBXMLMsgsRq>
</QBXML>",
"UserName":"{{file_username}}",
"Password":"{{file_password}}"
}
If your request takes more than 2.5 minutes, the response will contain a GUID to try again later. You will need to pass that GUID via the retrieve_id endpoint.
For example:
{
"RequestId": "9999da23-b388-43d6-9832-59bcebeedda0",
"Data": null,
"Success": true,
"RetryLater": true,
"Message": "Request has not been completed yet. Please check back in couple of minutes"
}
Please check the example below to see how the response will look like when there's a data.
{
"RequestId": null,
"Data": "<?xml version=\"1.0\" ?>\n<QBXML>\n<QBXMLMsgsRs>\n<CompanyQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">\n<CompanyRet>\n<IsSampleCompany>false</IsSampleCompany>\n<CompanyName>RAM Sample - Cougar Enterprises</CompanyName>\n<LegalCompanyName>Cougar Enterprises</LegalCompanyName>\n<Address>\n<Addr1>69 Smart Street</Addr1>\n<City>Melbourne</City>\n<State>VIC</State>\n<PostalCode>3001</PostalCode>\n</Address>\n<AddressBlock>\n<Addr1>69 Smart Street</Addr1>\n<Addr2>Melbourne, VIC 3001</Addr2>\n</AddressBlock>\n<LegalAddress>\n<Addr1>69 Smart Street</Addr1>\n<City>Melbourne</City>\n<State>VIC</State>\n<PostalCode>3001</PostalCode>\n</LegalAddress>\n<Phone>03 9854 1222</Phone>\n<Fax>03 9854 1223</Fax>\n<Email>Accounts@cougar.com.au</Email>\n<CompanyWebSite>www.cougar.com.au</CompanyWebSite>\n<FirstMonthFiscalYear>July</FirstMonthFiscalYear>\n<FirstMonthIncomeTaxYear>July</FirstMonthIncomeTaxYear>\n<EIN>98 765 432 154/</EIN>\n<TaxForm>OtherOrNone</TaxForm>\n</CompanyRet>\n</CompanyQueryRs>\n</QBXMLMsgsRs>\n</QBXML>\n",
"Success": true,
"RetryLater": false,
"Message": "Your data was processed successfully"
}
You will use this endpoint if your response contains a GUID in the RequestId object and where RetryLater is true. This GUID is to be used to try again later to get the response for the payload sent initially.
This happens if your request takes more than 2.5 minutes.
Example response that contains GUID:
{"RequestId":"8af1bdf7-a1e6-44e0-b64b-ae4e42c235cc","Data":null,"Success":true,"RetryLater":true,"Message":"Request has not been completed yet. Please check back in couple of minutes"}
You will then pass the RequestId via this endpoint to get the result instead of sending the same payload again.
RequestId from the response
Use this endpoint to see the list of company files that a user has access to.
Find more out from the help article: https://help.reckon.com/article/un0vbkogzw
{
"numberOfFiles": 71,
"availableFiles": [
{
"fileName": "My Company file.QBW",
"filePath": "Q:\\My Company file.QBW",
"lastWrite_datetime": "2021-02-11T02:06:02.648Z"
},
{
"fileName": "Shared File.QBW",
"filePath": "\\\\RAH-FSS-06-AP2B\\057185-1421910-SharedFile$\\Shared File.QBW",
"lastWrite_datetime": "2021-10-23T14:09:22Z"
}
]
}
{
"FileName":"{{file_name}}",
"Operation":"<?xml version=\"1.0\"?>
<?qbxml version=\"6.1\"?>
<QBXML>
<QBXMLMsgsRq onError=\"continueOnError\">
<CompanyQueryRq />
</QBXMLMsgsRq>
</QBXML>",
"UserName":"{{file_username}}",
"Password":"{{file_password}}",
"CountryVersion": "{{country_version}}"
}
{
"FileName":"{{file_name}}",
"Operation":"<?xml version=\"1.0\"?>
<?qbxml version=\"6.1\"?>
<QBXML>
<QBXMLMsgsRq onError=\"continueOnError\">
<CompanyQueryRq />
</QBXMLMsgsRq>
</QBXML>",
"UserName":"{{file_username}}",
"Password":"{{file_password}}"
}
If your request takes more than 2.5 minutes, the response will contain a GUID to try again later. You will need to pass that GUID via the retrieve_id endpoint.
For example:
{
"RequestId": "9999da23-b388-43d6-9832-59bcebeedda0",
"Data": null,
"Success": true,
"RetryLater": true,
"Message": "Request has not been completed yet. Please check back in couple of minutes"
}
Please check the example below to see how the response will look like when there's a data.
{
"RequestId": null,
"Data": "<?xml version=\"1.0\" ?>\n<QBXML>\n<QBXMLMsgsRs>\n<CompanyQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">\n<CompanyRet>\n<IsSampleCompany>false</IsSampleCompany>\n<CompanyName>RAM Sample - Cougar Enterprises</CompanyName>\n<LegalCompanyName>Cougar Enterprises</LegalCompanyName>\n<Address>\n<Addr1>69 Smart Street</Addr1>\n<City>Melbourne</City>\n<State>VIC</State>\n<PostalCode>3001</PostalCode>\n</Address>\n<AddressBlock>\n<Addr1>69 Smart Street</Addr1>\n<Addr2>Melbourne, VIC 3001</Addr2>\n</AddressBlock>\n<LegalAddress>\n<Addr1>69 Smart Street</Addr1>\n<City>Melbourne</City>\n<State>VIC</State>\n<PostalCode>3001</PostalCode>\n</LegalAddress>\n<Phone>03 9854 1222</Phone>\n<Fax>03 9854 1223</Fax>\n<Email>Accounts@cougar.com.au</Email>\n<CompanyWebSite>www.cougar.com.au</CompanyWebSite>\n<FirstMonthFiscalYear>July</FirstMonthFiscalYear>\n<FirstMonthIncomeTaxYear>July</FirstMonthIncomeTaxYear>\n<EIN>98 765 432 154/</EIN>\n<TaxForm>OtherOrNone</TaxForm>\n</CompanyRet>\n</CompanyQueryRs>\n</QBXMLMsgsRs>\n</QBXML>\n",
"Success": true,
"RetryLater": false,
"Message": "Your data was processed successfully"
}
You will use this endpoint if your response contains a GUID in the RequestId object and where RetryLater is true. This GUID is to be used to try again later to get the response for the payload sent initially.
This happens if your request takes more than 2.5 minutes.
Example response that contains GUID:
{"RequestId":"8af1bdf7-a1e6-44e0-b64b-ae4e42c235cc","Data":null,"Success":true,"RetryLater":true,"Message":"Request has not been completed yet. Please check back in couple of minutes"}
You will then pass the RequestId via this endpoint to get the result instead of sending the same payload again.
RequestId from the response