---
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`

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`.

## Query parameters

- `reportType` ExcelReportTypes, required — unresolved $ref

## Response `200`

OK

- ExcelStatus
  - `lastGenerated` string — 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.
  - `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.

---

[API](https://skmtc.net/codatio/apis/lending.md) · [All operations](https://skmtc.net/codatio/apis/lending/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/lending/revisions/791e242d1faf/schema)