Metadata-Version: 2.1
Name: codat-assess
Version: 0.31.1
Summary: Python Client SDK Generated by Speakeasy
Home-page: UNKNOWN
Author: Speakeasy
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: certifi (>=2022.12.7)
Requires-Dist: charset-normalizer (>=2.1.1)
Requires-Dist: dataclasses-json-speakeasy (>=0.5.8)
Requires-Dist: idna (>=3.3)
Requires-Dist: jsonpath-python (>=1.0.6)
Requires-Dist: marshmallow (>=3.17.1)
Requires-Dist: marshmallow-enum (>=1.5.1)
Requires-Dist: mypy-extensions (>=0.4.3)
Requires-Dist: packaging (>=21.3)
Requires-Dist: pyparsing (>=3.0.9)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: requests (>=2.28.1)
Requires-Dist: six (>=1.16.0)
Requires-Dist: typing-inspect (>=0.8.0)
Requires-Dist: typing-extensions (>=4.3.0)
Requires-Dist: urllib3 (>=1.26.12)
Provides-Extra: dev
Requires-Dist: pylint (==2.16.2) ; extra == 'dev'

# Assess

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

<!-- Start SDK Installation -->
## SDK Installation

```bash
pip install codat-assess
```
<!-- End SDK Installation -->

## SDK Example Usage
<!-- Start SDK Example Usage -->
```python
import codatassess
from codatassess.models import operations

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

req = operations.GetAccountCategoryRequest(
    account_id='corrupti',
    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
)

res = s.categories.get_account_category(req)

if res.categorised_account is not None:
    # handle response
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## Available Resources and Operations


### [categories](docs/sdks/categories/README.md)

* [~~get_account_category~~](docs/sdks/categories/README.md#get_account_category) - Get suggested and/or confirmed category for a specific account :warning: **Deprecated**
* [~~list_accounts_categories~~](docs/sdks/categories/README.md#list_accounts_categories) - List suggested and confirmed account categories :warning: **Deprecated**
* [~~list_available_account_categories~~](docs/sdks/categories/README.md#list_available_account_categories) - List account categories :warning: **Deprecated**
* [~~update_account_category~~](docs/sdks/categories/README.md#update_account_category) - Update account categories :warning: **Deprecated**
* [~~update_accounts_categories~~](docs/sdks/categories/README.md#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated**

### [data_integrity](docs/sdks/dataintegrity/README.md)

* [get_data_integrity_status](docs/sdks/dataintegrity/README.md#get_data_integrity_status) - Get data integrity status
* [get_data_integrity_summaries](docs/sdks/dataintegrity/README.md#get_data_integrity_summaries) - Get data integrity summary
* [list_data_type_data_integrity_details](docs/sdks/dataintegrity/README.md#list_data_type_data_integrity_details) - List data type data integrity

### [excel_reports](docs/sdks/excelreports/README.md)

* [generate_excel_report](docs/sdks/excelreports/README.md#generate_excel_report) - Generate Excel report
* [get_accounting_marketing_metrics](docs/sdks/excelreports/README.md#get_accounting_marketing_metrics) - Get marketing metrics report
* [get_excel_report](docs/sdks/excelreports/README.md#get_excel_report) - Download Excel report
* [get_excel_report_generation_status](docs/sdks/excelreports/README.md#get_excel_report_generation_status) - Get Excel report status

### [reports](docs/sdks/reports/README.md)

* [get_accounts_for_enhanced_balance_sheet](docs/sdks/reports/README.md#get_accounts_for_enhanced_balance_sheet) - Get enhanced balance sheet accounts
* [get_accounts_for_enhanced_profit_and_loss](docs/sdks/reports/README.md#get_accounts_for_enhanced_profit_and_loss) - Get enhanced profit and loss accounts
* [get_commerce_customer_retention_metrics](docs/sdks/reports/README.md#get_commerce_customer_retention_metrics) - Get customer retention metrics
* [get_commerce_lifetime_value_metrics](docs/sdks/reports/README.md#get_commerce_lifetime_value_metrics) - Get lifetime value metric
* [get_commerce_orders_metrics](docs/sdks/reports/README.md#get_commerce_orders_metrics) - Get orders report
* [get_commerce_refunds_metrics](docs/sdks/reports/README.md#get_commerce_refunds_metrics) - Get refunds report
* [get_commerce_revenue_metrics](docs/sdks/reports/README.md#get_commerce_revenue_metrics) - Get commerce revenue metrics
* [~~get_enhanced_balance_sheet~~](docs/sdks/reports/README.md#get_enhanced_balance_sheet) - Get enhanced balance sheet report :warning: **Deprecated**
* [get_enhanced_cash_flow_transactions](docs/sdks/reports/README.md#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report
* [~~get_enhanced_financial_metrics~~](docs/sdks/reports/README.md#get_enhanced_financial_metrics) - List financial metrics :warning: **Deprecated**
* [get_enhanced_invoices_report](docs/sdks/reports/README.md#get_enhanced_invoices_report) - Get enhanced invoices report
* [~~get_enhanced_profit_and_loss~~](docs/sdks/reports/README.md#get_enhanced_profit_and_loss) - Get enhanced profit and loss report :warning: **Deprecated**
* [get_loan_summary](docs/sdks/reports/README.md#get_loan_summary) - Get enhanced loan summaries
* [get_recurring_revenue_metrics](docs/sdks/reports/README.md#get_recurring_revenue_metrics) - Get key subscription revenue metrics
* [list_loan_transactions](docs/sdks/reports/README.md#list_loan_transactions) - List enhanced loan transactions
* [request_recurring_revenue_metrics](docs/sdks/reports/README.md#request_recurring_revenue_metrics) - Generate key subscription revenue metrics
<!-- End SDK Available Operations -->

### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)


