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

# Generate Excel report

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

Generate an Excel report which can subsequently be downloaded.

## 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` — The request made is not valid.
- `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/assess-api.md) · [All operations](https://skmtc.net/codatio/apis/assess-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/assess-api/revisions/5f4027e77a0e/schema)