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

791e242d1faf

Accounting bank data3

Accounts payable16

Accounts receivable23

Bank statements16

Companies6

Company info2

Connections5

Data integrity3

Excel reports3

File upload3

Financial statements7

Financial summary2

Liabilities4

Loan writeback19

Manage data5

Manage reports3

Sales23

Transactions13

Webhooks

Excel reports

Generate Excel report

The Generate Excel report endpoint requests the production of a downloadable Excel file for a report type specified in the reportType query parameter.

In response, the endpoint returns the status detailing the current state of the report generation request.

Report types

reportType	Description
audit	Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence.
enhancedCashFlow	Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow.
enhancedFinancials	Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes.
enhancedInvoices	Helps verify that payments have been made against historic invoices. Great for invoice finance lenders.

Learn more about valid Excel report types.

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

Query parameters

reportTypeExcelReportTypes required— unresolved $ref

The type of report you want to generate and download.

Response

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
}