Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 53 additions & 21 deletions static/oas/Codat-Lending.json
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@
"description": "Generate and review generated reports for a company."
},
{
"name": "Credit model",
"description": "Generate and review generated credit model reports for a company."
"name": "Financial summary",
"description": "View financial summary information for a company, including credit model reports and accounting score."
}
],
"paths": {
Expand Down Expand Up @@ -110243,7 +110243,7 @@
],
"get": {
"tags": [
"Credit model"
"Financial summary"
],
"summary": "Download credit model Excel",
"description": "> **Available as beta release**\n>\n> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.\n\nUse the *Download Credit Model Excel* endpoint to download the credit model Excel file. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`.",
Expand Down Expand Up @@ -110407,22 +110407,30 @@
],
"get": {
"tags": [
"Credit model"
"Financial summary"
],
"summary": "Get closed books indicator",
"description": "> **Available as beta release**\n>\n> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.\n\nThe Closed Books Indicator is a derived date parameter that determines when a business has closed its accounting books. \n\nBefore using this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`.",
"operationId": "get-closed-books-indicator",
"x-speakeasy-name-override": "get-closed-books-indicator",
"summary": "Get financial summary insights",
"description": "> **Available as beta release**\n>\n> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.\n\nFinancial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include:\n- Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business\n- Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping\n\nBefore accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`.\n\n> Please note that missing elements might be disabled for the account. Please contact account manager for more details.",
"operationId": "get-financial-summary",
"x-speakeasy-name-override": "get-financial-summary",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClosedBooksIndicator"
"$ref": "#/components/schemas/FinancialSummary"
},
"example": {
"booksClosedDate": "2025-05-31T00:00:00Z"
"booksClosedDate": "2025-05-31T00:00:00Z",
"accountingScore": {
"score": 90,
"reason": [
"Balance sheet is unbalanced.",
"Negative Tangible Assets on Balance Sheet",
"Negative Accounts Receivable on Balance Sheet"
]
}
}
}
}
Expand Down Expand Up @@ -116894,17 +116902,6 @@
}
}
},
"ClosedBooksIndicator": {
"title": "Closed Books Indicator",
"type": "object",
"properties": {
"booksClosedDate": {
"type": "string",
"description": "The date time in UTC the books closed.",
"example": "2025-05-31T00:00:00Z"
}
}
},
"CommerceAddress": {
"title": "Commerce: Address",
"x-internal": true,
Expand Down Expand Up @@ -120801,6 +120798,41 @@
}
}
},
"FinancialSummary": {
"title": "Closed Books Indicator",
"type": "object",
"properties": {
"booksClosedDate": {
"type": "string",
"description": "The date time in UTC the books closed.",
"example": "2025-05-31T00:00:00Z"
},
"accountingScore": {
"type": "object",
"description": "A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.",
"properties": {
"score": {
"type": "number",
"format": "decimal",
"description": "The accounting score value.",
"example": 90
},
"reason": {
"type": "array",
"description": "List of reasons explaining the accounting score.",
"items": {
"type": "string"
},
"example": [
"Balance sheet is unbalanced.",
"Negative Tangible Assets on Balance Sheet",
"Negative Accounts Receivable on Balance Sheet"
]
}
}
}
}
},
"LoanSummary": {
"title": "Loan summary",
"type": "object",
Expand Down
Loading