-
Notifications
You must be signed in to change notification settings - Fork 44
docs(lending): add CBS report retention policy to Supported Outputs #1874
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -216,6 +216,21 @@ You can also generate and download a report in an Excel format via the [Portal]( | |||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π [vale] <Google.Contractions> reported by reviewdog πΆ
Suggested change
|
||||||
| - **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. | ||||||
|
pmckinney-codat marked this conversation as resolved.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π [vale] <Google.Passive> reported by reviewdog πΆ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π [vale] <Google.Passive> reported by reviewdog πΆ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. π [vale] <Google.Contractions> reported by reviewdog πΆ
Suggested change
|
||||||
|
|
||||||
| 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`. | ||||||
|
pmckinney-codat marked this conversation as resolved.
pmckinney-codat marked this conversation as resolved.
pmckinney-codat marked this conversation as resolved.
|
||||||
|
|
||||||
| :::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. | ||||||
|
pmckinney-codat marked this conversation as resolved.
|
||||||
|
|
||||||
| ::: | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Read next | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π [vale] <Google.Passive> reported by reviewdog πΆ
In general, use active voice instead of passive voice ('are retained').