---
title: "Get financial summary insights"
method: GET
path: "/companies/{companyId}/reports/creditModel/{reportId}/financialSummary"
tags: ["Financial summary"]
---

# Get financial summary insights

`GET /companies/{companyId}/reports/creditModel/{reportId}/financialSummary`

## Request

- Base URL: `https://api.codat.io`
- URL: `https://api.codat.io/companies/{companyId}/reports/creditModel/{reportId}/financialSummary`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/codatio/apis/lending/docs/companies/:companyId/reports/creditModel/:reportId/financialSummary/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Available as beta release**
>
> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.

Financial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include:
- Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business
- Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping

Before accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`.

> Please note that missing elements might be disabled for the account. Please contact account manager for more details.

## Response `200`

OK

- FinancialSummary
  - `booksClosedDate` object: The date time in UTC the books closed.
    - `date` string, date-time: The date time in UTC the books closed.
    - `reason` string[]: List of reasons explaining the books closed date.
  - `accountingScore` object: A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.
    - `score` number: The accounting score value.
    - `reason` string[]: List of reasons explaining the accounting score.

## Other responses

- `204`: No content
- `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.

## Changes

- **2026-01-21** `e480d9c8ce50`: 1 breaking, 2 info
  - the `booksClosedDate` response's property type changed from `string` to `object` for status `200`
  - added the optional property `booksClosedDate/date` to the response with the `200` status
  - added the optional property `booksClosedDate/reason` to the response with the `200` status
- **2025-11-28** `043b6316864f`: 4 info
  - api operation id `get-closed-books-indicator` removed and replaced with `get-financial-summary`
  - api tag `Financial summary` added
  - api tag `Credit model` removed
  - added the optional property `accountingScore` to the response with the `200` status
- **2025-07-02** `683ddf83622a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/codatio/apis/lending/changes/companies/:companyId/reports/creditModel/:reportId/financialSummary/get.md)

---

[API](https://skmtc.dev/codatio/apis/lending.md) - [All operations](https://skmtc.dev/codatio/apis/lending/llms.txt) - [OpenAPI document](https://skmtc.dev/codatio/apis/lending/revisions/c81b2fd3063d?raw)