Skip to content

Credit Model docs#1704

Merged
pzaichkina merged 26 commits into
mainfrom
MED-372-Credit-Model-docs
Dec 3, 2025
Merged

Credit Model docs#1704
pzaichkina merged 26 commits into
mainfrom
MED-372-Credit-Model-docs

Conversation

@ivasiutkova
Copy link
Copy Markdown
Collaborator

@ivasiutkova ivasiutkova commented Nov 17, 2025

Description

  • Include a summary of the new content you're adding or the reason for the change.
  • Include relevant context.
  • Do not link to work items.
  • Any PNG images should be compressed using Tiny PNG or equivalent.

Type of change

Please delete options that are not relevant.

  • New document(s)/updating existing
  • Fixes
  • Styling
  • Bug fix (non-breaking change which fixes an issue)

Reviews and merging

You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.


Note

Introduces the premium Credit Model docs with API/Portal instructions, adds related webhook events, updates the Lending sidebar, adds an accounting integrations filter, and includes a new image asset.

  • Docs (Lending):
    • Add docs/lending/premium-products/credit-model-overview.md describing features, enrichments, supported outputs, API endpoints (generate-report, download-credit-model-excel, get-financial-summary), setup steps, required data types, and webhook guidance.
    • Add image static/img/lending/lending-credit-model-portal.png.
  • Webhooks:
    • In docs/using-the-api/webhooks/event-types.md, add Lending events: reports.creditModel.generate.successful and reports.creditModel.generate.unsuccessful.
  • Sidebar:
    • Update sidebars/lending.js to add link to lending/premium-products/credit-model-overview under Premium features.
  • Components:
    • In src/components/Integrations/integrations.js, add integrationsAccountingFilterCreditModel and export bankingIntegrations for use in the new doc.

Written by Cursor Bugbot for commit 7b2ef47. This will update automatically on new commits. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented Nov 17, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
codat-docs Ready Ready Preview Comment Dec 3, 2025 0:52am

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 17, 2025

Overall readability score: 57.62 (🔴 -0.02)

File Readability
event-types.md 68.47 (🟢 +1.25)
credit-model-overview.md 47.33 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
event-types.md 68.47 50.23 7.63 9.6 11.82 7.1
  🟢 +1.25 🟢 +0.21 🟢 +0.27 🟢 +0.1 🟢 +0 🟢 +0.19
credit-model-overview.md 47.33 31.28 10.93 13.5 15.01 7.78
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 57.62 48.37 10.39 11.64 12.16 7.84
  🔴 -0.02 🔴 -0.03 🟢 +0 🟢 +0 🔴 -0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@ivasiutkova ivasiutkova requested a review from Copilot November 26, 2025 12:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for Codat's Credit Model feature, a premium lending product that provides data-driven assessment of business financial health and creditworthiness.

Key changes:

  • Created new Credit Model overview documentation page
  • Added Credit Model navigation link to the lending sidebar under "Premium products" section

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
sidebars/lending.js Added Credit Model link under Premium products section in the lending sidebar
docs/lending/premium-products/credit-model-overview.md New comprehensive documentation covering Credit Model features, components, insights, and setup instructions

Comment thread docs/lending/premium-products/credit-model-overview.md Outdated
Comment thread docs/lending/premium-products/credit-model-overview.md Outdated
Comment on lines +45 to +56
frameborder="0"
className="googleSheets"
style={{ height: "450px" }}
/>

### Banking components supported across integrations

<iframe
src="https://docs.google.com/spreadsheets/d/1VEE7uUH_Q4ZGReonOqfZVT6V4-C40rwsMNEp2K7hOhQ/pubhtml?gid=1760315404&amp;single=true&amp;widget=true&amp;headers=false"
frameborder="0"
className="googleSheets"
style={{ height: "200px" }}
Copy link

Copilot AI Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The frameborder attribute is deprecated in HTML5. Use CSS style attribute with border: 0 or border: none instead.

Suggested change
frameborder="0"
className="googleSheets"
style={{ height: "450px" }}
/>
### Banking components supported across integrations
<iframe
src="https://docs.google.com/spreadsheets/d/1VEE7uUH_Q4ZGReonOqfZVT6V4-C40rwsMNEp2K7hOhQ/pubhtml?gid=1760315404&amp;single=true&amp;widget=true&amp;headers=false"
frameborder="0"
className="googleSheets"
style={{ height: "200px" }}
className="googleSheets"
style={{ border: "none", height: "450px" }}
/>
### Banking components supported across integrations
<iframe
src="https://docs.google.com/spreadsheets/d/1VEE7uUH_Q4ZGReonOqfZVT6V4-C40rwsMNEp2K7hOhQ/pubhtml?gid=1760315404&amp;single=true&amp;widget=true&amp;headers=false"
className="googleSheets"
style={{ border: "none", height: "200px" }}

Copilot uses AI. Check for mistakes.
ivasiutkova and others added 2 commits November 26, 2025 12:16
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Added detailed instructions for generating reports via API and Codat Portal.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 3, 2025

Link check results for preview deployment (https://codat-docs-git-MED-372-Credit-Model-docs-codat.vercel.app):

[
  "[401] https://codat-docs-git-med-372-credit-model-docs-codat.vercel.app/"
]

@pzaichkina pzaichkina merged commit 9a924ae into main Dec 3, 2025
4 of 8 checks passed
@pzaichkina pzaichkina deleted the MED-372-Credit-Model-docs branch December 3, 2025 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants