Skip to content

docs(lending): add CBS report retention policy to Supported Outputs #1848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hmansour-codat wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs(lending): add CBS report retention policy to Supported Outputs #1848

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f1fb401
docs(lending): add CBS report retention policy to Supported Outputs
hmansour-codat Jun 15, 2026
3e140de
revert(lending): remove CBS retention section from bank-statements-ov…
hmansour-codat Jun 15, 2026
8394d33
docs(lending): add CBS report retention policy to excel-download Supp…
hmansour-codat Jun 17, 2026
a8d517b
Update report retention section for clarity
hmansour-codat Jun 17, 2026
7008f58
Merge branch 'main' into patch-3
hmansour-codat Jun 17, 2026
9586311
Fix formatting in excel-download-overview.md
hmansour-codat Jun 17, 2026
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
15 changes: 15 additions & 0 deletions docs/lending/features/excel-download-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,21 @@

You can also generate and download the **data export** report by clicking the **Export data** button on any of the Lending screens of the Portal.

#### Report retention

Lending reports are subject to two layers of retention:

- **Time-based:** all reports are retained for approximately 90 days from generation, after which they are automatically removed.

Check warning on line 223 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'they're' instead of 'they are'.

Raw Output:
{"message": "[Google.Contractions] Use 'they're' instead of 'they are'.", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 223, "column": 99}}}, "severity": "INFO"}

Check warning on line 223 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are retained').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are retained').", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 223, "column": 31}}}, "severity": "INFO"}
- **Count-based (categorized bank statements only):** only the most recent report is retained. When a new report is generated, the previous report is immediately deleted, even if it is still within the 90-day window.

Check warning on line 224 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'it's' instead of 'it is'.

Raw Output:
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 224, "column": 180}}}, "severity": "INFO"}

Check warning on line 224 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is generated').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is generated').", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 224, "column": 114}}}, "severity": "INFO"}

Check warning on line 224 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is retained').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is retained').", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 224, "column": 83}}}, "severity": "INFO"}

Check warning on line 224 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 224, "column": 17}}}, "severity": "INFO"}

Because categorized bank statements are cumulative — each report contains all transactions from connected accounts to date — the latest report always includes all data from prior reports. We recommend fetching the most recent report using the [`/latest` endpoint](/lending-api#/operations/get-categorized-bank-statement) rather than storing and re-requesting a specific `reportId`.

Check failure on line 226 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.

Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 226, "column": 123}}}, "severity": "ERROR"}

Check failure on line 226 in docs/lending/features/excel-download-overview.md

View workflow job for this annotation

GitHub Actions / Vale linting 

[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.

Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/lending/features/excel-download-overview.md", "range": {"start": {"line": 226, "column": 51}}}, "severity": "ERROR"}

:::note 404 on older report IDs

Requesting a superseded `reportId` via `GET /reports/{reportId}` returns a **404** response. This is expected — the report has been removed by the retention policy, not due to an error. Always use `/latest` to reliably retrieve the current report.

:::

---

## Read next
Expand Down
Loading