COcodatio
Excel reports

Get Excel report status

Changed on

Returns the status of the latest report requested.

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

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/data/companies/{companyId}/assess/excel
  • Auth
    API key in header Authorization

Query parameters

reportType'assess' | 'audit' | 'enhancedFinancials' | 'enhancedInvoices' 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
}

Changes

  • 799428add8dcRevision changes
    • breaking

      removed the enum value enhancedCashFlow from the query request parameter reportType

    • info

      removed the enhancedCashFlow enum value from the response property for the response status

  • 0167fa08722eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status