Skip to content
Closed
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The following example shows how to switch Codat to point to Plaid Development in

Get your existing environment credentials.

1. Open the <a href="https://api.codat.io/swagger/ui/index.html#/Integrations/Integrations_GetCredentials" target="_blank">`GET /integrations/credentials/{platformKey}`</a> endpoint.
1. Open the <a href="https://api.codat.io/swagger/index.html#/Integrations/get_integrations_credentials__platformKey_" target="_blank">`GET /integrations/credentials/{platformKey}`</a> endpoint.
2. Replace `{platformKey}` with `plaid` and send your request to return your current credentials. Save the JSON, you'll need it later.

```json
Expand All @@ -60,7 +60,7 @@ Find the secret for Plaid's development environment.

Update your environment credentials.

1. Open the <a href="https://api.codat.io/swagger/ui/index#!/Integrations/Integrations_PutCredentials" target="_blank">
1. Open the <a href="https://api.codat.io/swagger/index.html#/Integrations/put_integrations_credentials__platformKey_" target="_blank">
`PUT /integrations/credentials/{platformKey}`</a> endpoint.
2. Replace `{platformKey}` with `plaid` and send the following details:
- The existing environment credentials you fetched earlier, replacing the original **clientSecret** with the secret for the development environment.
Expand Down
15 changes: 15 additions & 0 deletions docs/lending/features/excel-download-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Copy link
Copy Markdown

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').

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

πŸ“ [vale] <Google.Contractions> reported by reviewdog 🐢
Use 'they're' instead of 'they are'.

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

- **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.
Comment thread
pmckinney-codat marked this conversation as resolved.

Copy link
Copy Markdown

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 ('is retained').

Copy link
Copy Markdown

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 ('is generated').

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

πŸ“ [vale] <Google.Contractions> reported by reviewdog 🐢
Use 'it's' instead of 'it is'.

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.
- **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's still within the 90-day window.


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`.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
pmckinney-codat marked this conversation as resolved.
Comment thread
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.
Comment thread
pmckinney-codat marked this conversation as resolved.

:::

---

## Read next
Expand Down
Loading