Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-042018163.3 KB

5f4027e77a0e

Excel reports

Get Excel report status

Returns the status of the latest report requested.

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

Query parameters

reportType'assess' | 'audit' | 'enhancedFinancials' | 'enhancedInvoices' | 'enhancedCashFlow' required

The type of report you want to generate and download.

Response

OK

lastGeneratedDate — unresolved $ref
inProgressboolean

When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.

queuedstring

The date and time of when a successful request was queued for the most recent report.

successboolean

True if the requested report was successfully queued and false if the requested report was not able to be queued.

errorMessagestring

Error details in case the report generation request was unsuccessful.

lastInvocationIdstring

A unique ID generated for this request.

reportTypeExcelReportTypes — unresolved $ref
fileSizeinteger nullable

The file size in Bytes is populated upon successful generation of the report.

Example response

{
  "lastGenerated": "2023-01-25T22:36:05.125Z",
  "inProgress": true,
  "queued": "2023-01-25T22:36:05.125Z",
  "success": true,
  "errorMessage": "string",
  "lastInvocationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportType": "string",
  "fileSize": 0
}