Get financial summary insights
Changed onAvailable 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 endpoint of type creditModel.
Please note that missing elements might be disabled for the account. Please contact account manager for more details.
Request
- Base URLhttps://api.codat.io
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
OK
Example response
{
"booksClosedDate": {
"date": "2025-05-31T00:00:00Z",
"reason": [
"One or more accounts show a deviation from expected movements for March 2025",
"One of the marketing accounts haven't been booked for February 2025",
"One of the inventory accounts haven't been booked for March 2025"
]
},
"accountingScore": {
"score": 90,
"reason": [
"Balance sheet is unbalanced.",
"Negative Tangible Assets on Balance Sheet",
"Negative Accounts Receivable on Balance Sheet"
]
}
}Changes
- breaking
the
response's property type changed fromstringtoobjectfor status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status
- breaking
- info
api operation id
get-closed-books-indicatorremoved and replaced withget-financial-summary - info
api tag
Financial summaryadded - info
api tag
Credit modelremoved - info
added the optional property
to the response with the status
- info