Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
Project description
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 install codat-lending
Example Usage
SDK Example Usage
Example
import codatlending
from codatlending.models import shared
s = codatlending.CodatLending(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req)
if res.company is not None:
# handle response
pass
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
transactions.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
transactions.journal_entries
transactions.journals
accounting_bank_data
- list_transactions - List bank account transactions
accounting_bank_data.accounts
banking.account_balances
- list - List account balances
banking.accounts
banking.transaction_categories
banking.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
accounts_payable.bill_payments
sales.customers
sales.disputes
sales.locations
sales.orders
sales.payment_methods
sales.payments
sales.product_categories
sales.products
sales.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
accounts_receivable.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
financial_statements.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
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:
import codatlending
from codatlending.models import shared
from codatlending.utils import BackoffStrategy, RetryConfig
s = codatlending.CodatLending(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req,
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))
if res.company 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:
import codatlending
from codatlending.models import shared
from codatlending.utils import BackoffStrategy, RetryConfig
s = codatlending.CodatLending(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req)
if res.company 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 | 4x-5xx | / |
Example
import codatlending
from codatlending.models import errors, shared
s = codatlending.CodatLending(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = None
try:
res = s.companies.create(req)
except errors.ErrorMessage as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.company 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
import codatlending
from codatlending.models import shared
s = codatlending.CodatLending(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req)
if res.company 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:
import codatlending
from codatlending.models import shared
s = codatlending.CodatLending(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req)
if res.company is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests 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 a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import codatlending
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatlending.CodatLending(client: http_client)
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:
import codatlending
from codatlending.models import shared
s = codatlending.CodatLending(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
req = shared.CompanyRequestBody(
name='Bank of Dave',
description='Requested early access to the new financing scheme.',
)
res = s.companies.create(req)
if res.company is not None:
# handle response
pass
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for codat_lending-6.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6060f13042196d16459db122ed689379412d85be69546c551666da6a1af7068 |
|
MD5 | 98f8d0d1bc74c9f8013e5deceb0c35d5 |
|
BLAKE2b-256 | e4ee627b23f99cc2ab31ea4e63f862125643b7b13e5a1411800efbbbcc6fd522 |