Package: codat-assess
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.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.SDK Installationpipinstallcodat-assessExample UsageSDK Example UsageExampleimportcodatassessfromcodatassess.modelsimportoperationss=codatassess.CodatAssess(auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req)ifres.status_code==200:# handle responsepassAvailable Resources and Operationsreportsgenerate_loan_summary- Generate loan summaries reportgenerate_loan_transactions- Generate loan transactions reportget_accounts_for_enhanced_balance_sheet- Get enhanced balance sheet accountsget_accounts_for_enhanced_profit_and_loss- Get enhanced profit and loss accountsget_commerce_customer_retention_metrics- Get customer retention metricsget_commerce_lifetime_value_metrics- Get lifetime value metricget_commerce_orders_metrics- Get orders reportget_commerce_refunds_metrics- Get refunds reportget_commerce_revenue_metrics- Get commerce revenue metricsget_enhanced_cash_flow_transactions- Get enhanced cash flow reportget_enhanced_invoices_report- Get enhanced invoices reportget_loan_summary- Get loan summariesget_recurring_revenue_metrics- Get key subscription revenue metricslist_loan_transactions- List loan transactionsrequest_recurring_revenue_metrics- Generate key subscription revenue metricsdata_integritydetails- List data type data integritystatus- Get data integrity statussummary- Get data integrity summaryexcel_reportsgenerate_excel_report- Generate Excel reportget_accounting_marketing_metrics- Get marketing metrics reportget_excel_report- Download Excel reportget_excel_report_generation_status- Get Excel report statusRetriesSome 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:importcodatassessfromcodatassess.modelsimportoperationsfromcodatassess.utilsimportBackoffStrategy,RetryConfigs=codatassess.CodatAssess(auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req,RetryConfig('backoff',BackoffStrategy(1,50,1.1,100),False))ifres.status_code==200:# handle responsepassIf you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:importcodatassessfromcodatassess.modelsimportoperationsfromcodatassess.utilsimportBackoffStrategy,RetryConfigs=codatassess.CodatAssess(retry_config=RetryConfig('backoff',BackoffStrategy(1,50,1.1,100),False)auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req)ifres.status_code==200:# handle responsepassError HandlingHandling 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 ObjectStatus CodeContent Typeerrors.ErrorMessage401,402,403,404,429,500,503application/jsonerrors.SDKError400-600/Exampleimportcodatassessfromcodatassess.modelsimportoperationss=codatassess.CodatAssess(auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=Nonetry:res=s.reports.generate_loan_summary(req)excepterrors.ErrorMessagease:print(e)# handle exceptionraise(e)excepterrors.SDKErrorase:print(e)# handle exceptionraise(e)ifres.status_code==200:# handle responsepassServer SelectionSelect Server by IndexYou can override the default server globally by passing a server index to theserver_idx: intoptional 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:#ServerVariables0https://api.codat.ioNoneExampleimportcodatassessfromcodatassess.modelsimportoperationss=codatassess.CodatAssess(server_idx=0,auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req)ifres.status_code==200:# handle responsepassOverride Server URL Per-ClientThe default server can also be overridden globally by passing a URL to theserver_url: stroptional parameter when initializing the SDK client instance. For example:importcodatassessfromcodatassess.modelsimportoperationss=codatassess.CodatAssess(server_url="https://api.codat.io",auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req)ifres.status_code==200:# handle responsepassCustom HTTP ClientThe Python SDK makes API calls using the (requests)[https://pypi.org/project/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 customrequests.Sessionobject.For example, you could specify a header for every request that this sdk makes as follows:importcodatassessimportrequestshttp_client=requests.Session()http_client.headers.update({'x-custom-header':'someValue'})s=codatassess.CodatAssess(client:http_client)AuthenticationPer-Client Security SchemesThis SDK supports the following security scheme globally:NameTypeSchemeauth_headerapiKeyAPI keyTo authenticate with the API theauth_headerparameter must be set when initializing the SDK client instance. For example:importcodatassessfromcodatassess.modelsimportoperationss=codatassess.CodatAssess(auth_header="Basic BASE_64_ENCODED(API_KEY)",)req=operations.GenerateLoanSummaryRequest(company_id='8a210b68-6988-11ed-a1eb-0242ac120002',source_type=operations.SourceType.ACCOUNTING,)res=s.reports.generate_loan_summary(req)ifres.status_code==200:# handle responsepassSupportIf 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 oursupport team.
We're here to help ensure a smooth experience for you.Library generated bySpeakeasy