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:
- Request an Excel report for download
- Check the progress status of the latest report requested (optional)
- 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
- Audit Report: Identifies indicators of inaccurate or out-of-date accounts, helping you to decision with confidence
- Enhanced Cash Flow Report: Contains enhanced cash flow data
- Enhanced Financials Report: Contains enhanced profit and loss and balance sheet data, allowing you to calculate key metrics
- Enhanced Invoices Report: Contains enhanced invoices which are linked to payments
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.
| Parameter | Type | Description | Required |
|---|---|---|---|
| companyId | string | The company ID for which you want to produce an Excel report for download. | Required |
| reportType | string | The 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
| Field | Type | Description |
|---|---|---|
| lastGenerated | date | The date and time of the report that is being generated. |
| inProgress | boolean | True - the request was successful and the report is being generated. False - the request was unsuccessful and the report is not being generated. |
| queued | date | The time a successful request was queued. |
| succcess | boolean | True - the requested report was successfully queued. False - the requested report wasn’t able to be queued. |
| errorMessage | string | The error message if the status was unsuccessful. |
| lastInvocationId | string | A unique ID generated for this request. |
| reportType | string | The report requested in the query string. |
{
"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
| Field | Type | Description |
|---|---|---|
| lastGenerated | string, See date | The date and time of the report that is being generated. |
| inProgress | boolean | True - the request was successful and the report is being generated. False - the request was unsuccessful and the report is not being generated. |
| queued | string, See date | The time a successful request was queued. |
| success | boolean | True - the requested report was successfully queued. False - the requested report wasn't able to be queued. |
| errorMessage | string | The error message if the status was unsuccessful. |
| lastInvocationId | string | A unique ID generated for this request. |
| reportType | string | The report requested in the query string. |
{
"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.