Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041561443.9 MB

791e242d1faf

Excel reports

Get Excel report status

The Get Excel report status returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests.

Poll this endpoint to check the progress of the report once you have requested its generation. This will not affect the generation of the report.

When the report generation completes successfully, the inProgress property will be marked as false and the success field will be marked as true.

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

Query parameters

reportTypeExcelReportTypes required— unresolved $ref

The type of report you want to generate and download.

Response

OK

lastGeneratedstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

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
}