codat-lending 7.0.0

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.

SDK Installation

PIP

pip install codat-lending

Poetry

poetry add codat-lending

Example Usage

SDK Example Usage

Example

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

s = CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

if res is not None:
    # handle response
    pass

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

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

async def main():
    s = CodatLending(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    )
    res = await s.companies.create_async(request={
        "name": "Technicalium",
        "description": "Requested early access to the new financing scheme.",
        "groups": [
            {
                "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
    })
    if res is not None:
        # handle response
        pass

asyncio.run(main())

Available Resources and Operations

companies

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

connections

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

bank_statements

• 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

transactions.account_transactions

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

transactions.direct_costs

• 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.transfers

• get - Get transfer
• list - List transfers

transactions.journal_entries

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

transactions.journals

• get - Get journal
• list - List journals

accounting_bank_data

• list_transactions - List bank account transactions

accounting_bank_data.accounts

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

banking.account_balances

• list - List account balances

banking.accounts

• get - Get account
• list - List accounts

banking.transaction_categories

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

banking.transactions

• get - Get bank transaction
• list - List transactions

banking.categorized_statement

• get - Get categorized bank statement

accounts_payable.bills

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

accounts_payable.suppliers

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

accounts_payable.bill_credit_notes

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

accounts_payable.bill_payments

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

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.orders

• get - Get order
• list - List orders

sales.payment_methods

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

sales.payments

• get - Get payment
• list - List payments

sales.product_categories

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

sales.products

• get - Get product
• list - List products

sales.transactions

• get - Get transaction
• list - List transactions

sales.metrics

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

sales.reports

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

company_info

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

accounts_receivable.customers

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

accounts_receivable.direct_incomes

• 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

accounts_receivable.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

accounts_receivable.credit_notes

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

accounts_receivable.payments

• get - Get payment
• list - List payments

accounts_receivable.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

file_upload

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

loan_writeback.bank_accounts

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

loan_writeback.bank_transactions

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

loan_writeback.accounts

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

loan_writeback.direct_costs

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

loan_writeback.payments

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

loan_writeback.suppliers

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

loan_writeback.transfers

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

loan_writeback.create_operations

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

financial_statements.accounts

• get - Get account
• list - List accounts

financial_statements.balance_sheet

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

financial_statements.cash_flow

• get - Get cash flow statement

financial_statements.profit_and_loss

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

manage_data

• get_status - Get data status

manage_data.refresh

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

manage_data.pull_operations

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

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

data_integrity

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

excel_reports

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

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 codatlending.utils import BackoffStrategy, RetryConfig

s = CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
},
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

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 codatlending.utils import BackoffStrategy, RetryConfig

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


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

if res is not None:
    # handle response
    pass

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	Status Code	Content Type
errors.ErrorMessage	400,401,402,403,429,500,503	application/json
errors.SDKError	4xx-5xx	/

Example

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

s = CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

res = None
try:
    res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

except errors.ErrorMessage as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res is not None:
    # handle response
    pass

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://api.codat.io	None

Example

from codat_lending import CodatLending
from codat_lending.models import shared

s = CodatLending(
    server_idx=0,
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

if res is not None:
    # handle response
    pass

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:

from codat_lending import CodatLending
from codat_lending.models import shared

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


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

if res is not None:
    # handle response
    pass

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

s = CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)


res = s.companies.create(request={
    "name": "Technicalium",
    "description": "Requested early access to the new financing scheme.",
    "groups": [
        {
            "id": "60d2fa12-8a04-11ee-b9d1-0242ac120002",
        },
    ],
})

if res is not None:
    # handle response
    pass

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

s = CodatLending(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)


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

# Use the SDK ...

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