codat-lending

Name	codat-lending JSON
Version	10.1.0 JSON
	download
home_page	https://github.com/codatio/client-sdk-python.git
Summary	Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
upload_time	2025-01-06 09:26:46
maintainer	None
docs_url	None
author	Speakeasy
requires_python	<4.0,>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 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 software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.

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.

[Explore product](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)
  * [Endpoints](https://github.com/codatio/client-sdk-python/blob/master/#endpoints)
  * [SDK Installation](https://github.com/codatio/client-sdk-python/blob/master/#sdk-installation)
  * [Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#example-usage)
  * [SDK Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#sdk-example-usage)
  * [Available Resources and Operations](https://github.com/codatio/client-sdk-python/blob/master/#available-resources-and-operations)
  * [Retries](https://github.com/codatio/client-sdk-python/blob/master/#retries)
  * [Error Handling](https://github.com/codatio/client-sdk-python/blob/master/#error-handling)
  * [Server Selection](https://github.com/codatio/client-sdk-python/blob/master/#server-selection)
  * [Custom HTTP Client](https://github.com/codatio/client-sdk-python/blob/master/#custom-http-client)
  * [Authentication](https://github.com/codatio/client-sdk-python/blob/master/#authentication)
  * [IDE Support](https://github.com/codatio/client-sdk-python/blob/master/#ide-support)
  * [File uploads](https://github.com/codatio/client-sdk-python/blob/master/#file-uploads)
  * [Debugging](https://github.com/codatio/client-sdk-python/blob/master/#debugging)
  * [Support](https://github.com/codatio/client-sdk-python/blob/master/#support)

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

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

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

### 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
```
<!-- End SDK Installation [installation] -->

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

### Example

```python
# Synchronous Example
from codat_lending import CodatLending

with CodatLending() as codat_lending:

    codat_lending.account_categories_updated(request={
        "alert_id": "a9367074-b5c3-42c4-9be4-be129f43577e",
        "client_id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
        "client_name": "Bank of Dave",
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "data": {
            "modified_date": "2022-10-23",
        },
        "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
        "message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.",
        "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
        "rule_type": "Account Categories Updated",
    })

    # Use the SDK ...
```

</br>

The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from codat_lending import CodatLending

async def main():
    async with CodatLending() as codat_lending:

        await codat_lending.account_categories_updated_async(request={
            "alert_id": "a9367074-b5c3-42c4-9be4-be129f43577e",
            "client_id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
            "client_name": "Bank of Dave",
            "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
            "data": {
                "modified_date": "2022-10-23",
            },
            "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
            "message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.",
            "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
            "rule_type": "Account Categories Updated",
        })

        # Use the SDK ...

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransfers/README.md#get) - Get transfer
* [list](https://github.com/codatio/client-sdk-python/blob/master/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 codat_lending:

    res = codat_lending.companies.create(request={
        "name": "Technicalium",
        "description": "Requested early access to the new financing scheme.",
    },
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    assert res is not None

    # 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 codat_lending:

    res = codat_lending.companies.create(request={
        "name": "Technicalium",
        "description": "Requested early access to the new financing scheme.",
    })

    assert res is not None

    # Handle response
    print(res)

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

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

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a errors.SDKError exception, which has the following properties:

| Property        | Type             | Description           |
|-----------------|------------------|-----------------------|
| `.status_code`  | *int*            | The HTTP status code  |
| `.message`      | *str*            | The error message     |
| `.raw_response` | *httpx.Response* | The raw HTTP response |
| `.body`         | *str*            | The response content  |

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:

| Error Type          | Status Code                       | Content Type     |
| ------------------- | --------------------------------- | ---------------- |
| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json |
| errors.SDKError     | 4XX, 5XX                          | \*/\*            |

### Example

```python
from codat_lending import CodatLending
from codat_lending.models import errors, shared

with CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as codat_lending:
    res = None
    try:

        res = codat_lending.companies.create(request={
            "name": "Technicalium",
            "description": "Requested early access to the new financing scheme.",
        })

        assert res is not None

        # Handle response
        print(res)

    except errors.ErrorMessage as e:
        # handle e.data: errors.ErrorMessageData
        raise(e)
    except errors.SDKError as e:
        # handle exception
        raise(e)
```
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from codat_lending import CodatLending
from codat_lending.models import shared

with CodatLending(
    server_url="https://api.codat.io",
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as codat_lending:

    res = codat_lending.companies.create(request={
        "name": "Technicalium",
        "description": "Requested early access to the new financing scheme.",
    })

    assert res is not None

    # Handle response
    print(res)

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

For example, you could specify a header for every request that this sdk makes as follows:
```python
from codat_lending import CodatLending
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CodatLending(client=http_client)
```

or you could wrap the client with your own custom logic:
```python
from codat_lending import CodatLending
from codat_lending.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = CodatLending(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name          | Type   | Scheme  |
| ------------- | ------ | ------- |
| `auth_header` | apiKey | API key |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```python
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 codat_lending:

    res = codat_lending.companies.create(request={
        "name": "Technicalium",
        "description": "Requested early access to the new financing scheme.",
    })

    assert res is not None

    # Handle response
    print(res)

```
<!-- End Authentication [security] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>

```python
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 codat_lending:

    codat_lending.file_upload.upload(request={
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    })

    # Use the SDK ...

```
<!-- End File uploads [file-upload] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from codat_lending import CodatLending
import logging

logging.basicConfig(level=logging.DEBUG)
s = CodatLending(debug_logger=logging.getLogger("codat_lending"))
```
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

<!-- Start Codat Support Notes -->
## Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. 
You can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](https://github.com/codatio/client-sdk-python/blob/master/mailto:support@codat.io).
We're here to help ensure a smooth experience for you.
<!-- End Codat Support Notes -->

<!-- Start Codat Generated By -->
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
<!-- End Codat Generated By -->
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/codatio/client-sdk-python.git",
    "name": "codat-lending",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Speakeasy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a5/eb/79cc1cdef26a256fb1f82cdbb7fb77375113c4c947a6161cb7f4930b29f0/codat_lending-10.1.0.tar.gz",
    "platform": null,
    "description": "# Lending\n\n<!-- Start Codat Library Description -->\nLending 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.\n<!-- End Codat Library Description -->\n\n<!-- Start Summary [summary] -->\n## Summary\n\nLending 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 software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.\n\nThe 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.\n\n[Explore product](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas)\n\n<!-- Start Codat Tags Table -->\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Companies | Create and manage your SMB users' companies. |\n| Connections | Create new and manage existing data connections for a company. |\n| Bank statements | Retrieve banking data from linked bank accounts. |\n| Sales | Retrieve standardized sales data from a linked commerce software. |\n| Financial statements | Financial data and reports from a linked accounting software. |\n| Liabilities | Debt and other liabilities. |\n| Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. |\n| Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. |\n| Transactions | Data from a linked accounting software representing transactions. |\n| Company info | View company information fetched from the source platform. |\n| Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. |\n| Excel reports | Download reports in Excel format. |\n| Manage data | Control how data is retrieved from an integration. |\n| File upload | Endpoints to manage uploaded files. |\n| 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. |\n<!-- End Codat Tags Table -->\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [Lending](https://github.com/codatio/client-sdk-python/blob/master/#lending)\n  * [Endpoints](https://github.com/codatio/client-sdk-python/blob/master/#endpoints)\n  * [SDK Installation](https://github.com/codatio/client-sdk-python/blob/master/#sdk-installation)\n  * [Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#example-usage)\n  * [SDK Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#sdk-example-usage)\n  * [Available Resources and Operations](https://github.com/codatio/client-sdk-python/blob/master/#available-resources-and-operations)\n  * [Retries](https://github.com/codatio/client-sdk-python/blob/master/#retries)\n  * [Error Handling](https://github.com/codatio/client-sdk-python/blob/master/#error-handling)\n  * [Server Selection](https://github.com/codatio/client-sdk-python/blob/master/#server-selection)\n  * [Custom HTTP Client](https://github.com/codatio/client-sdk-python/blob/master/#custom-http-client)\n  * [Authentication](https://github.com/codatio/client-sdk-python/blob/master/#authentication)\n  * [IDE Support](https://github.com/codatio/client-sdk-python/blob/master/#ide-support)\n  * [File uploads](https://github.com/codatio/client-sdk-python/blob/master/#file-uploads)\n  * [Debugging](https://github.com/codatio/client-sdk-python/blob/master/#debugging)\n  * [Support](https://github.com/codatio/client-sdk-python/blob/master/#support)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install codat-lending\n```\n\n### Poetry\n\n*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.\n\n```bash\npoetry add codat-lending\n```\n<!-- End SDK Installation [installation] -->\n\n## Example Usage\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom codat_lending import CodatLending\n\nwith CodatLending() as codat_lending:\n\n    codat_lending.account_categories_updated(request={\n        \"alert_id\": \"a9367074-b5c3-42c4-9be4-be129f43577e\",\n        \"client_id\": \"bae71d36-ff47-420a-b4a6-f8c9ddf41140\",\n        \"client_name\": \"Bank of Dave\",\n        \"company_id\": \"8a210b68-6988-11ed-a1eb-0242ac120002\",\n        \"data\": {\n            \"modified_date\": \"2022-10-23\",\n        },\n        \"data_connection_id\": \"2e9d2c44-f675-40ba-8049-353bfcb5e171\",\n        \"message\": \"Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.\",\n        \"rule_id\": \"70af3071-65d9-4ec3-b3cb-5283e8d55dac\",\n        \"rule_type\": \"Account Categories Updated\",\n    })\n\n    # Use the SDK ...\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom codat_lending import CodatLending\n\nasync def main():\n    async with CodatLending() as codat_lending:\n\n        await codat_lending.account_categories_updated_async(request={\n            \"alert_id\": \"a9367074-b5c3-42c4-9be4-be129f43577e\",\n            \"client_id\": \"bae71d36-ff47-420a-b4a6-f8c9ddf41140\",\n            \"client_name\": \"Bank of Dave\",\n            \"company_id\": \"8a210b68-6988-11ed-a1eb-0242ac120002\",\n            \"data\": {\n                \"modified_date\": \"2022-10-23\",\n            },\n            \"data_connection_id\": \"2e9d2c44-f675-40ba-8049-353bfcb5e171\",\n            \"message\": \"Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.\",\n            \"rule_id\": \"70af3071-65d9-4ec3-b3cb-5283e8d55dac\",\n            \"rule_type\": \"Account Categories Updated\",\n        })\n\n        # Use the SDK ...\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [accounting_bank_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingaccountingbankdata/README.md)\n\n* [list_transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingaccountingbankdata/README.md#list_transactions) - List bank account transactions\n\n#### [accounting_bank_data.accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounts/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounts/README.md#get) - Get bank account\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounts/README.md#list) - List bank accounts\n\n### [accounts_payable](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accountspayable/README.md)\n\n\n#### [accounts_payable.bill_credit_notes](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billcreditnotes/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billcreditnotes/README.md#get) - Get bill credit note\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billcreditnotes/README.md#list) - List bill credit notes\n\n#### [accounts_payable.bill_payments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billpayments/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billpayments/README.md#get) - Get bill payment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/billpayments/README.md#list) - List bill payments\n\n#### [accounts_payable.bills](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md#download_attachment) - Download bill attachment\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md#get) - Get bill\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md#get_attachment) - Get bill attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md#list) - List bills\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bills/README.md#list_attachments) - List bill attachments\n\n#### [accounts_payable.suppliers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md#download_attachment) - Download supplier attachment\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md#get) - Get supplier\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md#get_attachment) - Get supplier attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md#list) - List suppliers\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/suppliers/README.md#list_attachments) - List supplier attachments\n\n### [accounts_receivable](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accountsreceivable/README.md)\n\n\n#### [accounts_receivable.credit_notes](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/creditnotes/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/creditnotes/README.md#get) - Get credit note\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/creditnotes/README.md#list) - List credit notes\n\n#### [accounts_receivable.customers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md#download_attachment) - Download customer attachment\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md#get) - Get customer\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md#get_attachment) - Get customer attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md#list) - List customers\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customers/README.md#list_attachments) - List customer attachments\n\n#### [accounts_receivable.direct_incomes](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md#download_attachment) - Download direct income attachment\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md#get) - Get direct income\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md#get_attachment) - Get direct income attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md#list) - List direct incomes\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directincomes/README.md#list_attachments) - List direct income attachments\n\n#### [accounts_receivable.invoices](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#download_attachment) - Download invoice attachment\n* [download_pdf](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#download_pdf) - Get invoice as PDF\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#get) - Get invoice\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#get_attachment) - Get invoice attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#list) - List invoices\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#list_attachments) - List invoice attachments\n* [list_reconciled](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/invoices/README.md#list_reconciled) - List reconciled invoices\n\n#### [accounts_receivable.payments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/payments/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/payments/README.md#get) - Get payment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/payments/README.md#list) - List payments\n\n#### [accounts_receivable.reports](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/reports/README.md)\n\n* [get_aged_creditors](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/reports/README.md#get_aged_creditors) - Aged creditors report\n* [get_aged_debtors](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/reports/README.md#get_aged_debtors) - Aged debtors report\n* [is_aged_creditors_available](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/reports/README.md#is_aged_creditors_available) - Aged creditors report available\n* [is_aged_debtors_available](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/reports/README.md#is_aged_debtors_available) - Aged debtors report available\n\n### [bank_statements](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md)\n\n* [end_upload_session](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md#end_upload_session) - End upload session\n* [get_upload_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md#get_upload_configuration) - Get upload configuration\n* [set_upload_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md#set_upload_configuration) - Set upload configuration\n* [start_upload_session](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md#start_upload_session) - Start upload session\n* [upload_bank_statement_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankstatements/README.md#upload_bank_statement_data) - Upload data\n\n### [banking](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/banking/README.md)\n\n\n#### [banking.account_balances](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accountbalances/README.md)\n\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accountbalances/README.md#list) - List account balances\n\n#### [banking.accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingaccounts/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingaccounts/README.md#get) - Get account\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingaccounts/README.md#list) - List accounts\n\n#### [banking.categorized_statement](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/categorizedstatement/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/categorizedstatement/README.md#get) - Get categorized bank statement\n\n#### [banking.transaction_categories](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transactioncategories/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transactioncategories/README.md#get) - Get transaction category\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transactioncategories/README.md#list) - List transaction categories\n\n#### [banking.transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingbankingtransactions/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingbankingtransactions/README.md#get) - Get bank transaction\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingbankingtransactions/README.md#list) - List transactions\n\n\n### [companies](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md#create) - Create company\n* [delete](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md#delete) - Delete a company\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md#get) - Get company\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md#list) - List companies\n* [update](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companies/README.md#update) - Update company\n\n### [company_info](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companyinfo/README.md)\n\n* [get_accounting_profile](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companyinfo/README.md#get_accounting_profile) - Get company accounting profile\n* [get_commerce_profile](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companyinfo/README.md#get_commerce_profile) - Get company commerce profile\n\n### [connections](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#create) - Create connection\n* [delete](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#delete) - Delete connection\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#get) - Get connection\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#list) - List connections\n* [unlink](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#unlink) - Unlink connection\n\n### [data_integrity](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/dataintegrity/README.md)\n\n* [details](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/dataintegrity/README.md#details) - List data integrity details\n* [status](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/dataintegrity/README.md#status) - Get data integrity status\n* [summaries](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/dataintegrity/README.md#summaries) - Get data integrity summaries\n\n### [excel_reports](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/excelreports/README.md)\n\n* [download](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/excelreports/README.md#download) - Download Excel report\n* [generate](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/excelreports/README.md#generate) - Generate Excel report\n* [get_status](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/excelreports/README.md#get_status) - Get Excel report status\n\n### [file_upload](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/fileupload/README.md)\n\n* [download](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/fileupload/README.md#download) - Download all files for a company\n* [list_uploaded](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/fileupload/README.md#list_uploaded) - List all files uploaded by a company\n* [upload](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/fileupload/README.md#upload) - Upload files for a company\n\n### [financial_statements](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/financialstatements/README.md)\n\n\n#### [financial_statements.accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingfinancialstatementsaccounts/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingfinancialstatementsaccounts/README.md#get) - Get account\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingfinancialstatementsaccounts/README.md#list) - List accounts\n\n#### [financial_statements.balance_sheet](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/balancesheet/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/balancesheet/README.md#get) - Get balance sheet\n* [get_categorized_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/balancesheet/README.md#get_categorized_accounts) - Get categorized balance sheet statement\n\n#### [financial_statements.cash_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/cashflow/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/cashflow/README.md#get) - Get cash flow statement\n\n#### [financial_statements.profit_and_loss](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/profitandloss/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/profitandloss/README.md#get) - Get profit and loss\n* [get_categorized_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/profitandloss/README.md#get_categorized_accounts) - Get categorized profit and loss statement\n\n### [liabilities](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/liabilities/README.md)\n\n* [generate_loan_summary](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/liabilities/README.md#generate_loan_summary) - Generate loan summaries report\n* [generate_loan_transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/liabilities/README.md#generate_loan_transactions) - Generate loan transactions report\n* [get_loan_summary](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/liabilities/README.md#get_loan_summary) - Get loan summaries\n* [list_loan_transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/liabilities/README.md#list_loan_transactions) - List loan transactions\n\n### [loan_writeback](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/loanwriteback/README.md)\n\n\n#### [loan_writeback.accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingloanwritebackaccounts/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingloanwritebackaccounts/README.md#create) - Create account\n* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingloanwritebackaccounts/README.md#get_create_model) - Get create account model\n\n#### [loan_writeback.bank_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankaccounts/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankaccounts/README.md#create) - Create bank account\n* [get_create_update_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/bankaccounts/README.md#get_create_update_model) - Get create/update bank account model\n\n#### [loan_writeback.bank_transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/banktransactions/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/banktransactions/README.md#create) - Create bank account transactions\n* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/banktransactions/README.md#get_create_model) - Get create bank account transactions model\n\n#### [loan_writeback.create_operations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/createoperations/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/createoperations/README.md#get) - Get create operation\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/createoperations/README.md#list) - List create operations\n\n#### [loan_writeback.direct_costs](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directcosts/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directcosts/README.md#create) - Create direct cost\n* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/directcosts/README.md#get_create_model) - Get create direct cost model\n\n#### [loan_writeback.payments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingpayments/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingpayments/README.md#create) - Create payment\n* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingpayments/README.md#get_create_model) - Get create payment model\n\n#### [loan_writeback.source_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sourceaccounts/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sourceaccounts/README.md#create) - Create source account\n* [create_mapping](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sourceaccounts/README.md#create_mapping) - Create bank feed account mapping\n* [list_mappings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sourceaccounts/README.md#list_mappings) - List bank feed account mappings\n\n#### [loan_writeback.suppliers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsuppliers/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsuppliers/README.md#create) - Create supplier\n* [get_create_update_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsuppliers/README.md#get_create_update_model) - Get create/update supplier model\n\n#### [loan_writeback.transfers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transfers/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transfers/README.md#create) - Create transfer\n* [get_create_model](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transfers/README.md#get_create_model) - Get create transfer model\n\n### [manage_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/managedata/README.md)\n\n* [get_status](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/managedata/README.md#get_status) - Get data status\n\n#### [manage_data.pull_operations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pulloperations/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pulloperations/README.md#get) - Get pull operation\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pulloperations/README.md#list) - List pull operations\n\n#### [manage_data.refresh](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refresh/README.md)\n\n* [all_data_types](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refresh/README.md#all_data_types) - Refresh all data\n* [data_type](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refresh/README.md#data_type) - Refresh data type\n\n### [manage_reports](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/managereports/README.md)\n\n* [generate_report](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/managereports/README.md#generate_report) - Generate report\n* [list_reports](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/managereports/README.md#list_reports) - List reports\n\n### [sales](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sales/README.md)\n\n\n#### [sales.customers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingcustomers/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingcustomers/README.md#get) - Get customer\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingcustomers/README.md#list) - List customers\n\n#### [sales.disputes](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/disputes/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/disputes/README.md#get) - Get dispute\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/disputes/README.md#list) - List disputes\n\n#### [sales.locations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/locations/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/locations/README.md#get) - Get location\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/locations/README.md#list) - List locations\n\n#### [sales.metrics](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/metrics/README.md)\n\n* [get_customer_retention](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/metrics/README.md#get_customer_retention) - Get customer retention metrics\n* [get_lifetime_value](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/metrics/README.md#get_lifetime_value) - Get lifetime value metrics\n* [get_revenue](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/metrics/README.md#get_revenue) - Get commerce revenue metrics\n\n#### [sales.orders](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/orders/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/orders/README.md#get) - Get order\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/orders/README.md#list) - List orders\n\n#### [sales.payment_methods](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/paymentmethods/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/paymentmethods/README.md#get) - Get payment method\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/paymentmethods/README.md#list) - List payment methods\n\n#### [sales.payments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsalespayments/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsalespayments/README.md#get) - Get payment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingsalespayments/README.md#list) - List payments\n\n#### [sales.product_categories](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/productcategories/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/productcategories/README.md#get) - Get product category\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/productcategories/README.md#list) - List product categories\n\n#### [sales.products](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/products/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/products/README.md#get) - Get product\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/products/README.md#list) - List products\n\n#### [sales.reports](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingreports/README.md)\n\n* [get_orders](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingreports/README.md#get_orders) - Get orders report\n* [get_refunds](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingreports/README.md#get_refunds) - Get refunds report\n\n#### [sales.transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransactions/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransactions/README.md#get) - Get transaction\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransactions/README.md#list) - List transactions\n\n### [transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/transactions/README.md)\n\n\n#### [transactions.account_transactions](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounttransactions/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounttransactions/README.md#get) - Get account transaction\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/accounttransactions/README.md#list) - List account transactions\n\n#### [transactions.direct_costs](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md)\n\n* [download_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md#download_attachment) - Download direct cost attachment\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md#get) - Get direct cost\n* [get_attachment](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md#get_attachment) - Get direct cost attachment\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md#list) - List direct costs\n* [list_attachments](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingdirectcosts/README.md#list_attachments) - List direct cost attachments\n\n#### [transactions.journal_entries](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journalentries/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journalentries/README.md#get) - Get journal entry\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journalentries/README.md#list) - List journal entries\n\n#### [transactions.journals](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journals/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journals/README.md#get) - Get journal\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/journals/README.md#list) - List journals\n\n#### [transactions.transfers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransfers/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransfers/README.md#get) - Get transfer\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/codatlendingtransfers/README.md#list) - List transfers\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome 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.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import shared\nfrom codat_lending.utils import BackoffStrategy, RetryConfig\n\nwith CodatLending(\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n\n    res = codat_lending.companies.create(request={\n        \"name\": \"Technicalium\",\n        \"description\": \"Requested early access to the new financing scheme.\",\n    },\n        RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n    assert res is not None\n\n    # Handle response\n    print(res)\n\n```\n\nIf 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:\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import shared\nfrom codat_lending.utils import BackoffStrategy, RetryConfig\n\nwith CodatLending(\n    retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n\n    res = codat_lending.companies.create(request={\n        \"name\": \"Technicalium\",\n        \"description\": \"Requested early access to the new financing scheme.\",\n    })\n\n    assert res is not None\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\nBy default, an API error will raise a errors.SDKError exception, which has the following properties:\n\n| Property        | Type             | Description           |\n|-----------------|------------------|-----------------------|\n| `.status_code`  | *int*            | The HTTP status code  |\n| `.message`      | *str*            | The error message     |\n| `.raw_response` | *httpx.Response* | The raw HTTP response |\n| `.body`         | *str*            | The response content  |\n\nWhen custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:\n\n| Error Type          | Status Code                       | Content Type     |\n| ------------------- | --------------------------------- | ---------------- |\n| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json |\n| errors.SDKError     | 4XX, 5XX                          | \\*/\\*            |\n\n### Example\n\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import errors, shared\n\nwith CodatLending(\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n    res = None\n    try:\n\n        res = codat_lending.companies.create(request={\n            \"name\": \"Technicalium\",\n            \"description\": \"Requested early access to the new financing scheme.\",\n        })\n\n        assert res is not None\n\n        # Handle response\n        print(res)\n\n    except errors.ErrorMessage as e:\n        # handle e.data: errors.ErrorMessageData\n        raise(e)\n    except errors.SDKError as e:\n        # handle exception\n        raise(e)\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import shared\n\nwith CodatLending(\n    server_url=\"https://api.codat.io\",\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n\n    res = codat_lending.companies.create(request={\n        \"name\": \"Technicalium\",\n        \"description\": \"Requested early access to the new financing scheme.\",\n    })\n\n    assert res is not None\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom codat_lending import CodatLending\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = CodatLending(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n    client: AsyncHttpClient\n\n    def __init__(self, client: AsyncHttpClient):\n        self.client = client\n\n    async def send(\n        self,\n        request: httpx.Request,\n        *,\n        stream: bool = False,\n        auth: Union[\n            httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n        ] = httpx.USE_CLIENT_DEFAULT,\n        follow_redirects: Union[\n            bool, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n    ) -> httpx.Response:\n        request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n        return await self.client.send(\n            request, stream=stream, auth=auth, follow_redirects=follow_redirects\n        )\n\n    def build_request(\n        self,\n        method: str,\n        url: httpx._types.URLTypes,\n        *,\n        content: Optional[httpx._types.RequestContent] = None,\n        data: Optional[httpx._types.RequestData] = None,\n        files: Optional[httpx._types.RequestFiles] = None,\n        json: Optional[Any] = None,\n        params: Optional[httpx._types.QueryParamTypes] = None,\n        headers: Optional[httpx._types.HeaderTypes] = None,\n        cookies: Optional[httpx._types.CookieTypes] = None,\n        timeout: Union[\n            httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n        extensions: Optional[httpx._types.RequestExtensions] = None,\n    ) -> httpx.Request:\n        return self.client.build_request(\n            method,\n            url,\n            content=content,\n            data=data,\n            files=files,\n            json=json,\n            params=params,\n            headers=headers,\n            cookies=cookies,\n            timeout=timeout,\n            extensions=extensions,\n        )\n\ns = CodatLending(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name          | Type   | Scheme  |\n| ------------- | ------ | ------- |\n| `auth_header` | apiKey | API key |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import shared\n\nwith CodatLending(\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n\n    res = codat_lending.companies.create(request={\n        \"name\": \"Technicalium\",\n        \"description\": \"Requested early access to the new financing scheme.\",\n    })\n\n    assert res is not None\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start File uploads [file-upload] -->\n## File uploads\n\nCertain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.\n\n> [!TIP]\n>\n> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.\n>\n\n```python\nfrom codat_lending import CodatLending\nfrom codat_lending.models import shared\n\nwith CodatLending(\n    security=shared.Security(\n        auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n    ),\n) as codat_lending:\n\n    codat_lending.file_upload.upload(request={\n        \"company_id\": \"8a210b68-6988-11ed-a1eb-0242ac120002\",\n        \"connection_id\": \"2e9d2c44-f675-40ba-8049-353bfcb5e171\",\n    })\n\n    # Use the SDK ...\n\n```\n<!-- End File uploads [file-upload] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom codat_lending import CodatLending\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = CodatLending(debug_logger=logging.getLogger(\"codat_lending\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n<!-- Start Codat Support Notes -->\n## Support\n\nIf you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. \nYou can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](https://github.com/codatio/client-sdk-python/blob/master/mailto:support@codat.io).\nWe're here to help ensure a smooth experience for you.\n<!-- End Codat Support Notes -->\n\n<!-- Start Codat Generated By -->\n### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n<!-- End Codat Generated By -->",
    "bugtrack_url": null,
    "license": null,
    "summary": "Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.",
    "version": "10.1.0",
    "project_urls": {
        "Homepage": "https://github.com/codatio/client-sdk-python.git",
        "Repository": "https://github.com/codatio/client-sdk-python.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "704427a2486fd993d833a2479d77d6b9e2578dfeddd454a4d3feae24d6276b6d",
                "md5": "39f435d0fb40c3e88b9288a983b1a2e7",
                "sha256": "f13ba2856c6520447c62fe2501c53b13f00a1066dcbdab2ed8b27569704fab88"
            },
            "downloads": -1,
            "filename": "codat_lending-10.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "39f435d0fb40c3e88b9288a983b1a2e7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 651777,
            "upload_time": "2025-01-06T09:26:45",
            "upload_time_iso_8601": "2025-01-06T09:26:45.238712Z",
            "url": "https://files.pythonhosted.org/packages/70/44/27a2486fd993d833a2479d77d6b9e2578dfeddd454a4d3feae24d6276b6d/codat_lending-10.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a5eb79cc1cdef26a256fb1f82cdbb7fb77375113c4c947a6161cb7f4930b29f0",
                "md5": "e29a5bc16b0f66a907ec6c0b97f27d74",
                "sha256": "2e7054709c2ae0977f7303107d1209d64b2cadcdac3548eb68d7cb91059b0f11"
            },
            "downloads": -1,
            "filename": "codat_lending-10.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e29a5bc16b0f66a907ec6c0b97f27d74",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 240476,
            "upload_time": "2025-01-06T09:26:46",
            "upload_time_iso_8601": "2025-01-06T09:26:46.511282Z",
            "url": "https://files.pythonhosted.org/packages/a5/eb/79cc1cdef26a256fb1f82cdbb7fb77375113c4c947a6161cb7f4930b29f0/codat_lending-10.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-06 09:26:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "codatio",
    "github_project": "client-sdk-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "codat-lending"
}