Skip to main content

Assess reports in Excel

Describes the process and endpoints for the generation and download of Assess Excel reports

The Excel reports endpoints are used to produce and download excel reports. For more information on available reports, see the report types section. These reports can be generated via the portal or the API.

The process to download an Excel report via the API is:

  1. Request an Excel report for download
  2. Check the progress status of the latest report requested (optional)
  3. Download the latest Excel report

Only one request will be processed at a time per SMB company and per report type. The generated report is kept in blob storage and gets replaced when a new one is generated. These reports will show you what data is available from our API without writing any code upfront, and how this can be uses to automatically generate your key financial metrics.

Available report types

Please also refer to the Metrics Template which demonstrates how we can use the data within the Enhanced Financials Report to calculate financial metrics.

Parameters

For each of the endpoints described below, you will provide the same parameters.

ParameterTypeDescriptionRequired
companyIdstringThe company ID for which you want to produce an Excel report for download.Required
reportTypestringThe type of report you want to generate and download. Allowed values are:
audit, enhancedCashFlow, enhancedFinancials and enhancedInvoices
Required

Request an Excel report for download

The endpoint is available in our API Reference.

POST /data/companies/{companyId}/assess/excel

FieldTypeDescription
lastGenerateddateThe date and time of the report that is being generated.
inProgressbooleanTrue - the request was successful and the report is being generated.
False - the request was unsuccessful and the report is not being generated.
queueddateThe time a successful request was queued.
succcessbooleanTrue - the requested report was successfully queued.
False - the requested report wasn’t able to be queued.
errorMessagestringThe error message if the status was unsuccessful.
lastInvocationIdstringA unique ID generated for this request.
reportTypestringThe report requested in the query string.
Example of an Excel report request
{
"lastGenerated": "2022-10-18T12:43:33.340Z",
"inProgress": true,
"queued": "2022-10-18T12:43:33.340Z",
"success": true,
"errorMessage": "string",
"lastInvocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reportType": "string"
}

Check status of the report

The status tells you if the last report requested is complete. It only returns the status of the last report requested, not for older requests. This step is optional and won't affect the generation of the report if it were skipped.

When the report is complete, the inProgress field will have the value false whilst the success field will have the value true.

The endpoint is available in our API reference.

GET /data/companies/{companyId}/assess/excel

FieldTypeDescription
lastGeneratedstring, See dateThe date and time of the report that is being generated.
inProgressbooleanTrue - the request was successful and the report is being generated.
False - the request was unsuccessful and the report is not being generated.
queuedstring, See dateThe time a successful request was queued.
successbooleanTrue - the requested report was successfully queued.
False - the requested report wasn't able to be queued.
errorMessagestringThe error message if the status was unsuccessful.
lastInvocationIdstringA unique ID generated for this request.
reportTypestringThe report requested in the query string.
Example of a status check request
{
"lastGenerated": "2022-10-18T12:44:46.081Z",
"inProgress": true,
"queued": "2022-10-18T12:44:46.081Z",
"success": true,
"errorMessage": "string",
"lastInvocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reportType": "string"
}

Download the report

The endpoint is available in our API reference.

GET /data/companies/{companyId}/assess/excel/download

The downloadable Excel file is available in the response. Click it to save to your local machine.


Was this page useful?
❤️
👍
🤔
👎
😭