codat-lending 11.0.0
Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
Requires Python: >=3.10

# Lending

<!-- Start Codat Library Description -->
Lending helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from the operating systems they are already using. You can use that data for automating decisioning and surfacing new insights on the customer, all via one API.
<!-- End Codat Library Description -->

<!-- Start Summary [summary] -->
## Summary

Lending: Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.

The Lending solution 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.

[Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas)

<!-- Start Codat Tags Table -->
## 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 software. |
| Financial statements | Financial data and reports from a linked accounting software. |
| Liabilities | Debt and other liabilities. |
| Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. |
| Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. |
| Transactions | Data from a linked accounting software representing transactions. |
| Company info | View company information fetched from the source platform. |
| Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. |
| Excel reports | Download reports in Excel format. |
| Manage data | Control how data is retrieved from an integration. |
| File upload | Endpoints to manage uploaded files. |
| Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. |
<!-- End Codat Tags Table -->
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [Lending](https://github.com/codatio/client-sdk-python/blob/master/lending/#lending)
  * [Endpoints](https://github.com/codatio/client-sdk-python/blob/master/lending/#endpoints)
  * [SDK Installation](https://github.com/codatio/client-sdk-python/blob/master/lending/#sdk-installation)
  * [Example Usage](https://github.com/codatio/client-sdk-python/blob/master/lending/#example-usage)
  * [SDK Example Usage](https://github.com/codatio/client-sdk-python/blob/master/lending/#sdk-example-usage)
  * [Available Resources and Operations](https://github.com/codatio/client-sdk-python/blob/master/lending/#available-resources-and-operations)
  * [Retries](https://github.com/codatio/client-sdk-python/blob/master/lending/#retries)
  * [Error Handling](https://github.com/codatio/client-sdk-python/blob/master/lending/#error-handling)
  * [Server Selection](https://github.com/codatio/client-sdk-python/blob/master/lending/#server-selection)
  * [Custom HTTP Client](https://github.com/codatio/client-sdk-python/blob/master/lending/#custom-http-client)
  * [Authentication](https://github.com/codatio/client-sdk-python/blob/master/lending/#authentication)
  * [IDE Support](https://github.com/codatio/client-sdk-python/blob/master/lending/#ide-support)
  * [File uploads](https://github.com/codatio/client-sdk-python/blob/master/lending/#file-uploads)
  * [Resource Management](https://github.com/codatio/client-sdk-python/blob/master/lending/#resource-management)
  * [Debugging](https://github.com/codatio/client-sdk-python/blob/master/lending/#debugging)
  * [Support](https://github.com/codatio/client-sdk-python/blob/master/lending/#support)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with *uv*, *pip*, or *poetry* package managers.

### uv

*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

```bash
uv add codat-lending
```

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install codat-lending
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add codat-lending
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from codat-lending python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "codat-lending",
# ]
# ///

from codat_lending import CodatLending

sdk = CodatLending(
  # SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->

## Example Usage
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
# Synchronous Example
from codat_lending import CodatLending
from codat_lending.models import shared


with CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cl_client:

    res = cl_client.companies.create(request={
        "name": "Technicalium",
    })

    # Handle response
    print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from codat_lending import CodatLending
from codat_lending.models import shared

async def main():

    async with CodatLending(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cl_client:

        res = await cl_client.companies.create_async(request={
            "name": "Technicalium",
        })

        # Handle response
        print(res)

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [AccountingBankData](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingaccountingbankdata/README.md)

* [list_transactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingaccountingbankdata/README.md#list_transactions) - List bank account transactions

#### [AccountingBankData.Accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounts/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounts/README.md#get) - Get bank account
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounts/README.md#list) - List bank accounts

### [AccountsPayable.BillCreditNotes](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billcreditnotes/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billcreditnotes/README.md#get) - Get bill credit note
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billcreditnotes/README.md#list) - List bill credit notes

### [AccountsPayable.BillPayments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billpayments/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billpayments/README.md#get) - Get bill payment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/billpayments/README.md#list) - List bill payments

### [AccountsPayable.Bills](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md#download_attachment) - Download bill attachment
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md#get) - Get bill
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md#get_attachment) - Get bill attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md#list) - List bills
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bills/README.md#list_attachments) - List bill attachments

### [AccountsPayable.Suppliers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md#download_attachment) - Download supplier attachment
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md#get) - Get supplier
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md#get_attachment) - Get supplier attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md#list) - List suppliers
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/suppliers/README.md#list_attachments) - List supplier attachments

### [AccountsReceivable.CreditNotes](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/creditnotes/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/creditnotes/README.md#get) - Get credit note
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/creditnotes/README.md#list) - List credit notes

### [AccountsReceivable.Customers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md#download_attachment) - Download customer attachment
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md#get) - Get customer
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md#get_attachment) - Get customer attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md#list) - List customers
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/customers/README.md#list_attachments) - List customer attachments

### [AccountsReceivable.DirectIncomes](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md#download_attachment) - Download direct income attachment
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md#get) - Get direct income
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md#get_attachment) - Get direct income attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md#list) - List direct incomes
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directincomes/README.md#list_attachments) - List direct income attachments

### [AccountsReceivable.Invoices](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#download_attachment) - Download invoice attachment
* [download_pdf](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#download_pdf) - Get invoice as PDF
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#get) - Get invoice
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#get_attachment) - Get invoice attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#list) - List invoices
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#list_attachments) - List invoice attachments
* [list_reconciled](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/invoices/README.md#list_reconciled) - List reconciled invoices

### [AccountsReceivable.Payments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/payments/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/payments/README.md#get) - Get payment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/payments/README.md#list) - List payments

### [AccountsReceivable.Reports](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/reports/README.md)

* [get_aged_creditors](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/reports/README.md#get_aged_creditors) - Aged creditors report
* [get_aged_debtors](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/reports/README.md#get_aged_debtors) - Aged debtors report
* [is_aged_creditors_available](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/reports/README.md#is_aged_creditors_available) - Aged creditors report available
* [is_aged_debtors_available](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/reports/README.md#is_aged_debtors_available) - Aged debtors report available

### [BankStatements](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md)

* [end_upload_session](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md#end_upload_session) - End upload session
* [get_upload_configuration](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md#get_upload_configuration) - Get upload configuration
* [set_upload_configuration](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md#set_upload_configuration) - Set upload configuration
* [start_upload_session](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md#start_upload_session) - Start upload session
* [upload_bank_statement_data](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankstatements/README.md#upload_bank_statement_data) - Upload data

### [Banking.AccountBalances](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accountbalances/README.md)

* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accountbalances/README.md#list) - List account balances

### [Banking.Accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingaccounts/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingaccounts/README.md#get) - Get account
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingaccounts/README.md#list) - List accounts

### [Banking.CategorizedStatement](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/categorizedstatement/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/categorizedstatement/README.md#get) - Get categorized bank statement

### [Banking.TransactionCategories](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transactioncategories/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transactioncategories/README.md#get) - Get transaction category
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transactioncategories/README.md#list) - List transaction categories

### [Banking.Transactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingbankingtransactions/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingbankingtransactions/README.md#get) - Get bank transaction
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingbankingtransactions/README.md#list) - List transactions

### [Companies](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#create) - Create company
* [delete](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#delete) - Delete a company
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#get) - Get company
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#list) - List companies
* [replace](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#replace) - Replace company
* [update](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companies/README.md#update) - Update company

### [CompanyInfo](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companyinfo/README.md)

* [get_accounting_profile](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile
* [get_commerce_profile](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/companyinfo/README.md#get_commerce_profile) - Get company commerce profile

### [Connections](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md#create) - Create connection
* [delete](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md#delete) - Delete connection
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md#get) - Get connection
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md#list) - List connections
* [unlink](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/connections/README.md#unlink) - Unlink connection

### [DataIntegrity](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/dataintegrity/README.md)

* [details](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/dataintegrity/README.md#details) - List data integrity details
* [status](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/dataintegrity/README.md#status) - Get data integrity status
* [summaries](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/dataintegrity/README.md#summaries) - Get data integrity summaries

### [ExcelReports](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/excelreports/README.md)

* [download](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/excelreports/README.md#download) - Download Excel report
* [generate](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/excelreports/README.md#generate) - Generate Excel report
* [get_status](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/excelreports/README.md#get_status) - Get Excel report status

### [FileUpload](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/fileupload/README.md)

* [download](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/fileupload/README.md#download) - Download all files for a company
* [list_uploaded](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/fileupload/README.md#list_uploaded) - List all files uploaded by a company
* [upload](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/fileupload/README.md#upload) - Upload files for a company

### [FinancialStatements.Accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md#get) - Get account
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md#list) - List accounts

### [FinancialStatements.BalanceSheet](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/balancesheet/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/balancesheet/README.md#get) - Get balance sheet
* [get_categorized_accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/balancesheet/README.md#get_categorized_accounts) - Get categorized balance sheet statement

### [FinancialStatements.CashFlow](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/cashflow/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/cashflow/README.md#get) - Get cash flow statement

### [FinancialStatements.ProfitAndLoss](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/profitandloss/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/profitandloss/README.md#get) - Get profit and loss
* [get_categorized_accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/profitandloss/README.md#get_categorized_accounts) - Get categorized profit and loss statement

### [Liabilities](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/liabilities/README.md)

* [generate_loan_summary](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/liabilities/README.md#generate_loan_summary) - Generate loan summaries report
* [generate_loan_transactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/liabilities/README.md#generate_loan_transactions) - Generate loan transactions report
* [get_loan_summary](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/liabilities/README.md#get_loan_summary) - Get loan summaries
* [list_loan_transactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/liabilities/README.md#list_loan_transactions) - List loan transactions

### [LoanWriteback.Accounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md#create) - Create account
* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md#get_create_model) - Get create account model

### [LoanWriteback.BankAccounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankaccounts/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankaccounts/README.md#create) - Create bank account
* [get_create_update_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/bankaccounts/README.md#get_create_update_model) - Get create/update bank account model

### [LoanWriteback.BankTransactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/banktransactions/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/banktransactions/README.md#create) - Create bank account transactions
* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/banktransactions/README.md#get_create_model) - Get create bank account transactions model

### [LoanWriteback.CreateOperations](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/createoperations/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/createoperations/README.md#get) - Get create operation
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/createoperations/README.md#list) - List create operations

### [LoanWriteback.DirectCosts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directcosts/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directcosts/README.md#create) - Create direct cost
* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/directcosts/README.md#get_create_model) - Get create direct cost model

### [LoanWriteback.Payments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingpayments/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingpayments/README.md#create) - Create payment
* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingpayments/README.md#get_create_model) - Get create payment model

### [LoanWriteback.SourceAccounts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/sourceaccounts/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/sourceaccounts/README.md#create) - Create source account
* [create_mapping](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/sourceaccounts/README.md#create_mapping) - Create bank feed account mapping
* [list_mappings](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/sourceaccounts/README.md#list_mappings) - List bank feed account mappings

### [LoanWriteback.Suppliers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsuppliers/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsuppliers/README.md#create) - Create supplier
* [get_create_update_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsuppliers/README.md#get_create_update_model) - Get create/update supplier model

### [LoanWriteback.Transfers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transfers/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transfers/README.md#create) - Create transfer
* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/transfers/README.md#get_create_model) - Get create transfer model

### [ManageReports](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/managereports/README.md)

* [generate_report](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/managereports/README.md#generate_report) - Generate report
* [list_reports](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/managereports/README.md#list_reports) - List reports

### [ManageData](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/managedata/README.md)

* [get_status](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/managedata/README.md#get_status) - Get data status

#### [ManageData.PullOperations](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/pulloperations/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/pulloperations/README.md#get) - Get pull operation
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/pulloperations/README.md#list) - List pull operations

#### [ManageData.Refresh](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/refresh/README.md)

* [all_data_types](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/refresh/README.md#all_data_types) - Refresh all data
* [data_type](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/refresh/README.md#data_type) - Refresh data type

### [Sales.Customers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingcustomers/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingcustomers/README.md#get) - Get customer
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingcustomers/README.md#list) - List customers

### [Sales.Disputes](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/disputes/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/disputes/README.md#get) - Get dispute
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/disputes/README.md#list) - List disputes

### [Sales.Locations](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/locations/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/locations/README.md#get) - Get location
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/locations/README.md#list) - List locations

### [Sales.Metrics](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/metrics/README.md)

* [get_customer_retention](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/metrics/README.md#get_customer_retention) - Get customer retention metrics
* [get_lifetime_value](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/metrics/README.md#get_lifetime_value) - Get lifetime value metrics
* [get_revenue](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/metrics/README.md#get_revenue) - Get commerce revenue metrics

### [Sales.Orders](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/orders/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/orders/README.md#get) - Get order
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/orders/README.md#list) - List orders

### [Sales.PaymentMethods](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/paymentmethods/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/paymentmethods/README.md#get) - Get payment method
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/paymentmethods/README.md#list) - List payment methods

### [Sales.Payments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsalespayments/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsalespayments/README.md#get) - Get payment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingsalespayments/README.md#list) - List payments

### [Sales.ProductCategories](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/productcategories/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/productcategories/README.md#get) - Get product category
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/productcategories/README.md#list) - List product categories

### [Sales.Products](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/products/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/products/README.md#get) - Get product
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/products/README.md#list) - List products

### [Sales.Reports](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingreports/README.md)

* [get_orders](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingreports/README.md#get_orders) - Get orders report
* [get_refunds](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingreports/README.md#get_refunds) - Get refunds report

### [Sales.Transactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransactions/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransactions/README.md#get) - Get transaction
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransactions/README.md#list) - List transactions

### [Transactions.AccountTransactions](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounttransactions/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounttransactions/README.md#get) - Get account transaction
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/accounttransactions/README.md#list) - List account transactions

### [Transactions.DirectCosts](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md)

* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md#download_attachment) - Download direct cost attachment
* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md#get) - Get direct cost
* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md#get_attachment) - Get direct cost attachment
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md#list) - List direct costs
* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingdirectcosts/README.md#list_attachments) - List direct cost attachments

### [Transactions.JournalEntries](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journalentries/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journalentries/README.md#get) - Get journal entry
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journalentries/README.md#list) - List journal entries

### [Transactions.Journals](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journals/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journals/README.md#get) - Get journal
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/journals/README.md#list) - List journals

### [Transactions.Transfers](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransfers/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransfers/README.md#get) - Get transfer
* [list](https://github.com/codatio/client-sdk-python/blob/master/lending/docs/sdks/codatlendingtransfers/README.md#list) - List transfers

</details>
<!-- End Available Resources and Operations [operations] -->



<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from codat_lending import CodatLending
from codat_lending.models import shared
from codat_lending.utils import BackoffStrategy, RetryConfig


with CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cl_client:

    res = cl_client.companies.create(request={
        "name": "Technicalium",
    },
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from codat_lending import CodatLending
from codat_lending.models import shared
from codat_lending.utils import BackoffStrategy, RetryConfig


with CodatLending(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cl_client:

    res = cl_client.companies.create(request={
        "name": "Technicalium",
    })

    # Handle response
    print(res)

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`CodatLendingError`](https://github.com/codatio/client-sdk-python/blob/master/lending/./src/codat_lending/models/errors/codatlendingerror.py) is the base class for all HTTP error responses. It has the following properties:

| Property           | Type             | Description                                                                             |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message`      | `str`            | Error message                                                                           |
| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
| `