codat-lending 11.0.1

Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.

Lending

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.

Summary

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

The Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers.

Explore solution | See OpenAPI spec

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 procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.

Table of Contents

• Lending
  • Endpoints
  • SDK Installation
  • Example Usage
  • SDK Example Usage
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • IDE Support
  • File uploads
  • Resource Management
  • Debugging
  • Support

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

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

uv

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

uv add codat-lending

PIP

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

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.

poetry add codat-lending

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from codat-lending python

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

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

from codat_lending import CodatLending

sdk = CodatLending(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

Example Usage

SDK Example Usage

Example

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


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

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

    # Handle response
    print(res)

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

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

async def main():

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

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

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Available methods

AccountingBankData

• list_transactions - List bank account transactions

AccountingBankData.Accounts

• get - Get bank account
• list - List bank accounts

AccountsPayable.BillCreditNotes

• get - Get bill credit note
• list - List bill credit notes

AccountsPayable.BillPayments

• get - Get bill payment
• list - List bill payments

AccountsPayable.Bills

• download_attachment - Download bill attachment
• get - Get bill
• get_attachment - Get bill attachment
• list - List bills
• list_attachments - List bill attachments

AccountsPayable.Suppliers

• download_attachment - Download supplier attachment
• get - Get supplier
• get_attachment - Get supplier attachment
• list - List suppliers
• list_attachments - List supplier attachments

AccountsReceivable.CreditNotes

• get - Get credit note
• list - List credit notes

AccountsReceivable.Customers

• download_attachment - Download customer attachment
• get - Get customer
• get_attachment - Get customer attachment
• list - List customers
• list_attachments - List customer attachments

AccountsReceivable.DirectIncomes

• download_attachment - Download direct income attachment
• get - Get direct income
• get_attachment - Get direct income attachment
• list - List direct incomes
• list_attachments - List direct income attachments

AccountsReceivable.Invoices

• download_attachment - Download invoice attachment
• download_pdf - Get invoice as PDF
• get - Get invoice
• get_attachment - Get invoice attachment
• list - List invoices
• list_attachments - List invoice attachments
• list_reconciled - List reconciled invoices

AccountsReceivable.Payments

• get - Get payment
• list - List payments

AccountsReceivable.Reports

• get_aged_creditors - Aged creditors report
• get_aged_debtors - Aged debtors report
• is_aged_creditors_available - Aged creditors report available
• is_aged_debtors_available - Aged debtors report available

BankStatements

• end_upload_session - End upload session
• get_upload_configuration - Get upload configuration
• set_upload_configuration - Set upload configuration
• start_upload_session - Start upload session
• upload_bank_statement_data - Upload data

Banking.AccountBalances

• list - List account balances

Banking.Accounts

• get - Get account
• list - List accounts

Banking.CategorizedStatement

• get - Get categorized bank statement

Banking.TransactionCategories

• get - Get transaction category
• list - List transaction categories

Banking.Transactions

• get - Get bank transaction
• list - List transactions

Companies

• create - Create company
• delete - Delete a company
• get - Get company
• list - List companies
• replace - Replace company
• update - Update company

CompanyInfo

• get_accounting_profile - Get company accounting profile
• get_commerce_profile - Get company commerce profile

Connections

• create - Create connection
• delete - Delete connection
• get - Get connection
• list - List connections
• unlink - Unlink connection

DataIntegrity

• details - List data integrity details
• status - Get data integrity status
• summaries - Get data integrity summaries

ExcelReports

• download - Download Excel report
• generate - Generate Excel report
• get_status - Get Excel report status

FileUpload

• download - Download all files for a company
• list_uploaded - List all files uploaded by a company
• upload - Upload files for a company

FinancialStatements.Accounts

• get - Get account
• list - List accounts

FinancialStatements.BalanceSheet

• get - Get balance sheet
• get_categorized_accounts - Get categorized balance sheet statement

FinancialStatements.CashFlow

• get - Get cash flow statement

FinancialStatements.ProfitAndLoss

• get - Get profit and loss
• get_categorized_accounts - Get categorized profit and loss statement

Liabilities

• generate_loan_summary - Generate loan summaries report
• generate_loan_transactions - Generate loan transactions report
• get_loan_summary - Get loan summaries
• list_loan_transactions - List loan transactions

LoanWriteback.Accounts

• create - Create account
• get_create_model - Get create account model

LoanWriteback.BankAccounts

• create - Create bank account
• get_create_update_model - Get create/update bank account model

LoanWriteback.BankTransactions

• create - Create bank account transactions
• get_create_model - Get create bank account transactions model

LoanWriteback.CreateOperations

• get - Get create operation
• list - List create operations

LoanWriteback.DirectCosts

• create - Create direct cost
• get_create_model - Get create direct cost model

LoanWriteback.Payments

• create - Create payment
• get_create_model - Get create payment model

LoanWriteback.SourceAccounts

• create - Create source account
• create_mapping - Create bank feed account mapping
• list_mappings - List bank feed account mappings

LoanWriteback.Suppliers

• create - Create supplier
• get_create_update_model - Get create/update supplier model

LoanWriteback.Transfers

• create - Create transfer
• get_create_model - Get create transfer model

ManageReports

• generate_report - Generate report
• list_reports - List reports

ManageData

• get_status - Get data status

ManageData.PullOperations

• get - Get pull operation
• list - List pull operations

ManageData.Refresh

• all_data_types - Refresh all data
• data_type - Refresh data type

Sales.Customers

• get - Get customer
• list - List customers

Sales.Disputes

• get - Get dispute
• list - List disputes

Sales.Locations

• get - Get location
• list - List locations

Sales.Metrics

• get_customer_retention - Get customer retention metrics
• get_lifetime_value - Get lifetime value metrics
• get_revenue - Get commerce revenue metrics

Sales.Orders

• get - Get order
• list - List orders

Sales.PaymentMethods

• get - Get payment method
• list - List payment methods

Sales.Payments

• get - Get payment
• list - List payments

Sales.ProductCategories

• get - Get product category
• list - List product categories

Sales.Products

• get - Get product
• list - List products

Sales.Reports

• get_orders - Get orders report
• get_refunds - Get refunds report

Sales.Transactions

• get - Get transaction
• list - List transactions

Transactions.AccountTransactions

• get - Get account transaction
• list - List account transactions

Transactions.DirectCosts

• download_attachment - Download direct cost attachment
• get - Get direct cost
• get_attachment - Get direct cost attachment
• list - List direct costs
• list_attachments - List direct cost attachments

Transactions.JournalEntries

• get - Get journal entry
• list - List journal entries

Transactions.Journals

• get - Get journal
• list - List journals

Transactions.Transfers

• get - Get transfer
• list - List transfers

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:

from codat_lending import CodatLending
from codat_lending.models import shared
from codat_lending.utils import BackoffStrategy, RetryConfig


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

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

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from codat_lending import CodatLending
from codat_lending.models import shared
from codat_lending.utils import BackoffStrategy, RetryConfig


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

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

    # Handle response
    print(res)

Error Handling

CodatLendingError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

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 cl_client:
    res = None
    try:

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

        # Handle response
        print(res)


    except errors.CodatLendingError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ErrorMessage):
            print(e.data.can_be_retried)  # Optional[str]
            print(e.data.correlation_id)  # Optional[str]
            print(e.data.detailed_error_code)  # Optional[int]
            print(e.data.error)  # Optional[str]
            print(e.data.service)  # Optional[str]

Error Classes

Primary errors:

• CodatLendingError: The base class for HTTP error responses.
  • ErrorMessage: Your query parameter was not correctly formed.

Less common errors (5)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from CodatLendingError:

• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

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 cl_client:

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

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx 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:

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:

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()))

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:

from codat_lending import CodatLending
from codat_lending.models import shared


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

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

    # Handle response
    print(res)

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

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.

from codat_lending import CodatLending
from codat_lending.models import shared


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

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

    # Use the SDK ...

Resource Management

The CodatLending class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from codat_lending import CodatLending
from codat_lending.models import shared
def main():

    with CodatLending(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cl_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with CodatLending(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cl_client:
        # Rest of application here...

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.

from codat_lending import CodatLending
import logging

logging.basicConfig(level=logging.DEBUG)
s = CodatLending(debug_logger=logging.getLogger("codat_lending"))

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. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy