@codat/lending 0.1.0 → 1.2.0

package/docs/sdks/codatlending/README.md

@@ -2,13 +2,33 @@
 
 ## Overview
 
-Lending API: An API for uploading and downloading files from 'File Upload' Integrations.
+Lending API: Our Lending API helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce platforms they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.
 
-The Accounting file upload, Banking file upload, and Business documents file upload integrations provide simple file upload functionality.
+The Lending API is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers.
 
-[Read more...](https://docs.codat.io/other/file-upload)
+[Explore product](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas)
 
-[See our OpenAPI spec](https://github.com/codatio/oas) 
+---
+
+## Endpoints
+
+| Endpoints            | Description                                                                                                |
+|:---------------------|:-----------------------------------------------------------------------------------------------------------|
+| Companies            | Create and manage your SMB users' companies.                                                               |
+| Connections          | Create new and manage existing data connections for a company.                                             |
+| Bank statements      | Retrieve banking data from linked bank accounts.                                                           |
+| Sales                | Retrieve standardized sales data from a linked commerce platform.                                          |
+| Financial statements | Financial data and reports from a linked accounting platform.                                              |
+| Liabilities          | Debt and other liabilities.                                                                                |
+| Accounts payable     | Data from a linked accounting platform representing money the business owes money to its suppliers.        |
+| Accounts receivable  | Data from a linked accounting platform representing money owed to the business for sold goods or services. |
+| Transactions         | Data from a linked accounting platform representing transactions.                                          |
+| Data integrity       | Match mutable accounting data with immutable banking data to increase confidence in financial data.        |
+| Company info         | View company profile from the source platform.                                                             |
+| Excel reports        | Download reports in Excel format.                                                                          |
+| Categories           | Manage Codat's automatic account categorization functionality.                                             |
+| Manage data          | Control how data is retrieved from an integration.                                                         |
+| File upload          | Endpoints to manage uploaded files.                                                                        |
 
 ### Available Operations
 

package/docs/sdks/companies/README.md

@@ -155,7 +155,7 @@ sdk.companies.list({
   orderBy: "-modifiedDate",
   page: 1,
   pageSize: 100,
-  query: "nam",
+  query: "minus",
 }).then((res: ListCompaniesResponse) => {
   if (res.statusCode == 200) {
     // handle response

package/docs/sdks/companyinfo/README.md

@@ -6,10 +6,10 @@ View company information fetched from the source platform.
 
 ### Available Operations
 
-* [fromAccountingPlatform](#fromaccountingplatform) - Get company info
-* [fromCommercePlatform](#fromcommerceplatform) - Get company info
+* [getAccountingProfile](#getaccountingprofile) - Get company accounting profile
+* [getCommerceProfile](#getcommerceprofile) - Get company commerce profile
 
-## fromAccountingPlatform
+## getAccountingProfile
 
 Gets the latest basic info for a company.
 
@@ -17,7 +17,7 @@ Gets the latest basic info for a company.
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetAccountingCompanyInfoResponse } from "@codat/lending/dist/sdk/models/operations";
+import { GetAccountingProfileResponse } from "@codat/lending/dist/sdk/models/operations";
 
 const sdk = new CodatLending({
   security: {
@@ -25,9 +25,9 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.companyInfo.fromAccountingPlatform({
+sdk.companyInfo.getAccountingProfile({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: GetAccountingCompanyInfoResponse) => {
+}).then((res: GetAccountingProfileResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
@@ -36,19 +36,19 @@ sdk.companyInfo.fromAccountingPlatform({
 
 ### Parameters
 
-| Parameter                                                                                                | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                | [operations.GetAccountingCompanyInfoRequest](../../models/operations/getaccountingcompanyinforequest.md) | :heavy_check_mark:                                                                                       | The request object to use for the request.                                                               |
-| `retries`                                                                                                | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                   | :heavy_minus_sign:                                                                                       | Configuration to override the default retry behavior of the client.                                      |
-| `config`                                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                             | :heavy_minus_sign:                                                                                       | Available config options for making requests.                                                            |
+| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `request`                                                                                        | [operations.GetAccountingProfileRequest](../../models/operations/getaccountingprofilerequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
+| `retries`                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                           | :heavy_minus_sign:                                                                               | Configuration to override the default retry behavior of the client.                              |
+| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
 
 
 ### Response
 
-**Promise<[operations.GetAccountingCompanyInfoResponse](../../models/operations/getaccountingcompanyinforesponse.md)>**
+**Promise<[operations.GetAccountingProfileResponse](../../models/operations/getaccountingprofileresponse.md)>**
 
 
-## fromCommercePlatform
+## getCommerceProfile
 
 Retrieve information about the company, as seen in the commerce platform.
 
@@ -58,7 +58,7 @@ This may include information like addresses, tax registration details and social
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetCommerceCompanyInfoResponse } from "@codat/lending/dist/sdk/models/operations";
+import { GetCommerceProfileResponse } from "@codat/lending/dist/sdk/models/operations";
 
 const sdk = new CodatLending({
   security: {
@@ -66,10 +66,10 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.companyInfo.fromCommercePlatform({
+sdk.companyInfo.getCommerceProfile({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-}).then((res: GetCommerceCompanyInfoResponse) => {
+}).then((res: GetCommerceProfileResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
@@ -78,14 +78,14 @@ sdk.companyInfo.fromCommercePlatform({
 
 ### Parameters
 
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.GetCommerceCompanyInfoRequest](../../models/operations/getcommercecompanyinforequest.md) | :heavy_check_mark:                                                                                   | The request object to use for the request.                                                           |
-| `retries`                                                                                            | [utils.RetryConfig](../../models/utils/retryconfig.md)                                               | :heavy_minus_sign:                                                                                   | Configuration to override the default retry behavior of the client.                                  |
-| `config`                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                         | :heavy_minus_sign:                                                                                   | Available config options for making requests.                                                        |
+| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `request`                                                                                    | [operations.GetCommerceProfileRequest](../../models/operations/getcommerceprofilerequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
+| `retries`                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                       | :heavy_minus_sign:                                                                           | Configuration to override the default retry behavior of the client.                          |
+| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
 
 
 ### Response
 
-**Promise<[operations.GetCommerceCompanyInfoResponse](../../models/operations/getcommercecompanyinforesponse.md)>**
+**Promise<[operations.GetCommerceProfileResponse](../../models/operations/getcommerceprofileresponse.md)>**
 

package/docs/sdks/connections/README.md

@@ -32,7 +32,7 @@ const sdk = new CodatLending({
 
 sdk.connections.create({
   requestBody: {
-    platformKey: "officia",
+    platformKey: "placeat",
   },
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 }).then((res: CreateConnectionResponse) => {
@@ -158,7 +158,7 @@ sdk.connections.list({
   orderBy: "-modifiedDate",
   page: 1,
   pageSize: 100,
-  query: "occaecati",
+  query: "voluptatum",
 }).then((res: ListConnectionsResponse) => {
   if (res.statusCode == 200) {
     // handle response
@@ -189,6 +189,7 @@ sdk.connections.list({
 ```typescript
 import { CodatLending } from "@codat/lending";
 import { UnlinkConnectionResponse } from "@codat/lending/dist/sdk/models/operations";
+import { DataConnectionStatus } from "@codat/lending/dist/sdk/models/shared";
 
 const sdk = new CodatLending({
   security: {
@@ -198,7 +199,7 @@ const sdk = new CodatLending({
 
 sdk.connections.unlink({
   requestBody: {
-    status: "fugit",
+    status: DataConnectionStatus.Linked,
   },
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",

package/docs/sdks/dataintegrity/README.md

@@ -12,7 +12,7 @@ Match mutable accounting data with immutable banking data to increase confidence
 
 ## details
 
-The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results.
+The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results.
 
 The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetails) are paginated and support ordering, following the same conventions as our other data endpoints.
 
@@ -35,7 +35,7 @@ sdk.dataIntegrity.details({
   orderBy: "-modifiedDate",
   page: 1,
   pageSize: 100,
-  query: "deleniti",
+  query: "excepturi",
 }).then((res: ListDataIntegrityDetailsResponse) => {
   if (res.statusCode == 200) {
     // handle response
@@ -59,7 +59,7 @@ sdk.dataIntegrity.details({
 
 ## status
 
-The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching.
+The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching.
 This endpoint helps you understand whether match data is available and, if so, how to usefully query it.
 
 The response tells you:
@@ -107,7 +107,7 @@ sdk.dataIntegrity.status({
 
 ## summaries
 
-The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). 
+The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). 
 
 For example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`.
 
@@ -129,7 +129,7 @@ const sdk = new CodatLending({
 sdk.dataIntegrity.summaries({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   dataType: DataIntegrityDataType.BankingAccounts,
-  query: "hic",
+  query: "nisi",
 }).then((res: GetDataIntegritySummariesResponse) => {
   if (res.statusCode == 200) {
     // handle response

package/docs/sdks/excelreports/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Downloadable reports
+Download reports in Excel format.
 
 ### Available Operations
 
@@ -57,12 +57,20 @@ sdk.excelReports.download({
 
 ## generate
 
-The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.
+The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter.
 
 In response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request.
 
-You can [learn more](https://docs.codat.io/lending/excel/overview) about valid Excel report types.
+### Report types
+
+| reportType                                                                           | Description                                                                                                                                   |
+|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| [audit](https://docs.codat.io/lending/excel/audit-report)                            | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence.                                                   || [audit](https://docs.codat.io/lending/excel/audit-report)                            | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence.                                                   |
+| [enhancedCashFlow](https://docs.codat.io/lending/excel/enhanced-invoices-report)     | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow.  |
+| [enhancedFinancials](https://docs.codat.io/lending/excel/enhanced-financials-report) | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes.                |
+| [enhancedInvoices](https://docs.codat.io/lending/excel/enhanced-invoices-report)     | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders.                                       |
 
+[Learn more](https://docs.codat.io/lending/excel/overview) about valid Excel report types.
 
 
 
@@ -82,7 +90,7 @@ const sdk = new CodatLending({
 
 sdk.excelReports.generate({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  reportType: ExcelReportTypes.EnhancedInvoices,
+  reportType: ExcelReportTypes.EnhancedCashFlow,
 }).then((res: GenerateExcelReportResponse) => {
   if (res.statusCode == 200) {
     // handle response

package/docs/sdks/fileupload/README.md

@@ -113,8 +113,8 @@ const sdk = new CodatLending({
 
 sdk.fileUpload.upload({
   requestBody: {
-    content: "molestiae".encode(),
-    requestBody: "modi",
+    content: "veritatis".encode(),
+    requestBody: "deserunt",
   },
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",

package/docs/sdks/financialstatements/README.md

@@ -0,0 +1,4 @@
+# financialStatements
+
+### Available Operations
+

package/docs/sdks/financialstatementsaccounts/README.md

@@ -0,0 +1,100 @@
+# financialStatementsAccounts
+
+### Available Operations
+
+* [get](#get) - Get account
+* [list](#list) - List accounts
+
+## get
+
+The *Get account* endpoint returns a single account for a given accountId.
+
+[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetAccountingAccountResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsAccounts.get({
+  accountId: "cum",
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+}).then((res: GetAccountingAccountResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `request`                                                                                        | [operations.GetAccountingAccountRequest](../../models/operations/getaccountingaccountrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
+| `retries`                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                           | :heavy_minus_sign:                                                                               | Configuration to override the default retry behavior of the client.                              |
+| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
+
+
+### Response
+
+**Promise<[operations.GetAccountingAccountResponse](../../models/operations/getaccountingaccountresponse.md)>**
+
+
+## list
+
+The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.
+
+[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListAccountingAccountsResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsAccounts.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "esse",
+}).then((res: ListAccountingAccountsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `request`                                                                                            | [operations.ListAccountingAccountsRequest](../../models/operations/listaccountingaccountsrequest.md) | :heavy_check_mark:                                                                                   | The request object to use for the request.                                                           |
+| `retries`                                                                                            | [utils.RetryConfig](../../models/utils/retryconfig.md)                                               | :heavy_minus_sign:                                                                                   | Configuration to override the default retry behavior of the client.                                  |
+| `config`                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                         | :heavy_minus_sign:                                                                                   | Available config options for making requests.                                                        |
+
+
+### Response
+
+**Promise<[operations.ListAccountingAccountsResponse](../../models/operations/listaccountingaccountsresponse.md)>**
+

package/docs/sdks/financialstatementsbalancesheet/README.md

@@ -0,0 +1,91 @@
+# financialStatementsBalanceSheet
+
+### Available Operations
+
+* [get](#get) - Get balance sheet
+* [getCategorizedAccounts](#getcategorizedaccounts) - Get categorized balance sheet statement
+
+## get
+
+Gets the latest balance sheet for a company.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetAccountingBalanceSheetResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsBalanceSheet.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  periodLength: 4,
+  periodsToCompare: 20,
+  startMonth: "2022-10-23T00:00:00.000Z",
+}).then((res: GetAccountingBalanceSheetResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                  | [operations.GetAccountingBalanceSheetRequest](../../models/operations/getaccountingbalancesheetrequest.md) | :heavy_check_mark:                                                                                         | The request object to use for the request.                                                                 |
+| `retries`                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                     | :heavy_minus_sign:                                                                                         | Configuration to override the default retry behavior of the client.                                        |
+| `config`                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                               | :heavy_minus_sign:                                                                                         | Available config options for making requests.                                                              |
+
+
+### Response
+
+**Promise<[operations.GetAccountingBalanceSheetResponse](../../models/operations/getaccountingbalancesheetresponse.md)>**
+
+
+## getCategorizedAccounts
+
+The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date.
+
+Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/enhanced-financials/overview#categorize-accounts) to a more suitable one.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCategorizedBalanceSheetStatementResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsBalanceSheet.getCategorizedAccounts({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  numberOfPeriods: 568434,
+  reportDate: "29-09-2020",
+}).then((res: GetCategorizedBalanceSheetStatementResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                                      | Type                                                                                                                           | Required                                                                                                                       | Description                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                      | [operations.GetCategorizedBalanceSheetStatementRequest](../../models/operations/getcategorizedbalancesheetstatementrequest.md) | :heavy_check_mark:                                                                                                             | The request object to use for the request.                                                                                     |
+| `retries`                                                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                         | :heavy_minus_sign:                                                                                                             | Configuration to override the default retry behavior of the client.                                                            |
+| `config`                                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                                   | :heavy_minus_sign:                                                                                                             | Available config options for making requests.                                                                                  |
+
+
+### Response
+
+**Promise<[operations.GetCategorizedBalanceSheetStatementResponse](../../models/operations/getcategorizedbalancesheetstatementresponse.md)>**
+

package/docs/sdks/financialstatementscashflow/README.md

@@ -0,0 +1,47 @@
+# financialStatementsCashFlow
+
+### Available Operations
+
+* [get](#get) - Get cash flow statement
+
+## get
+
+Gets the latest cash flow statement for a company.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetAccountingCashFlowStatementResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsCashFlow.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  periodLength: 4,
+  periodsToCompare: 20,
+  startMonth: "2022-10-23T00:00:00.000Z",
+}).then((res: GetAccountingCashFlowStatementResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                            | Type                                                                                                                 | Required                                                                                                             | Description                                                                                                          |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                            | [operations.GetAccountingCashFlowStatementRequest](../../models/operations/getaccountingcashflowstatementrequest.md) | :heavy_check_mark:                                                                                                   | The request object to use for the request.                                                                           |
+| `retries`                                                                                                            | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                               | :heavy_minus_sign:                                                                                                   | Configuration to override the default retry behavior of the client.                                                  |
+| `config`                                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                         | :heavy_minus_sign:                                                                                                   | Available config options for making requests.                                                                        |
+
+
+### Response
+
+**Promise<[operations.GetAccountingCashFlowStatementResponse](../../models/operations/getaccountingcashflowstatementresponse.md)>**
+