---
title: "Get Excel report status"
method: GET
path: "/data/companies/{companyId}/assess/excel"
tags: ["Excel reports"]
---

# Get Excel report status

`GET /data/companies/{companyId}/assess/excel`

Returns the status of the latest report requested.

## Query parameters

- `reportType` 'assess' | 'audit' | 'enhancedFinancials' | 'enhancedInvoices' | 'enhancedCashFlow', required

## Response `200`

OK

- ExcelStatus
  - `lastGenerated` Date — unresolved $ref
  - `inProgress` boolean — 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.
  - `queued` string — The date and time of when a successful request was queued for the most recent report.
  - `success` boolean — True if the requested report was successfully queued and false if the requested report was not able to be queued.
  - `errorMessage` string — Error details in case the report generation request was unsuccessful.
  - `lastInvocationId` string — A unique ID generated for this request.
  - `reportType` ExcelReportTypes — unresolved $ref
  - `fileSize` integer, nullable — The file size in Bytes is populated upon successful generation of the report.

## Other responses

- `400` — Your `query` parameter was not correctly formed
- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

## Changes

- **2024-02-13** `0167fa08722e` — 8 info
  - added the optional property `validation` to the response with the `400` status
  - added the optional property `validation` to the response with the `401` status
  - added the optional property `validation` to the response with the `402` status
  - added the optional property `validation` to the response with the `403` status
  - …4 more
- **2023-10-23** `7ca7ffc3edf1` — 6 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `402`
  - added the non-success response with the status `403`
  - added the non-success response with the status `429`
  - …2 more
- **2023-08-29** `5aaba265b198` — 1 breaking, 4 warning
  - the response property `fileSize` became nullable for the status `200`
  - added the new `audit` enum value to the `reportType` response property for the response status `200`
  - added the new `enhancedCashFlow` enum value to the `reportType` response property for the response status `200`
  - added the new `enhancedFinancials` enum value to the `reportType` response property for the response status `200`
  - …1 more

[Change history](https://skmtc.dev/codatio/apis/assess-api/changes/data/companies/:companyId/assess/excel/get.md)

---

[API](https://skmtc.dev/codatio/apis/assess-api.md) · [All operations](https://skmtc.dev/codatio/apis/assess-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/assess-api/revisions/5f4027e77a0e/schema)