Excel reports

Generate Excel report

Generate an Excel report which can subsequently be downloaded.

post/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

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
}

Changes

Changed in 3 of the 51 revisions of this API.1414

Feb 13, 20240167fa08722e8See the full diff
- ○
  added the optional property validation to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 402 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 503 status
  response-optional-property-added
Oct 23, 20237ca7ffc3edf16See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 402
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added
Aug 29, 20235aaba265b19814See the full diff
- ▲
  the response property fileSize became nullable for the status 200
  response-property-became-nullable
- ●
  added the new audit enum value to the reportType response property for the response status 200
  response-property-enum-value-added
- ●
  added the new enhancedCashFlow enum value to the reportType response property for the response status 200
  response-property-enum-value-added
- ●
  added the new enhancedFinancials enum value to the reportType response property for the response status 200
  response-property-enum-value-added
- ●
  added the new enhancedInvoices enum value to the reportType response property for the response status 200
  response-property-enum-value-added

Full history