@codat/assess NPM

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.

SDK Installation

NPM

npm add @codat/assess

Yarn

yarn add @codat/assess

Example Usage

SDK Example Usage

Example

import { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        sourceType: SourceType.Accounting,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Available Resources and Operations

reports

generateLoanSummary - Generate loan summaries report
generateLoanTransactions - Generate loan transactions report
getAccountsForEnhancedBalanceSheet - Get enhanced balance sheet accounts
getAccountsForEnhancedProfitAndLoss - Get enhanced profit and loss accounts
getCommerceCustomerRetentionMetrics - Get customer retention metrics
getCommerceLifetimeValueMetrics - Get lifetime value metric
getCommerceOrdersMetrics - Get orders report
getCommerceRefundsMetrics - Get refunds report
getCommerceRevenueMetrics - Get commerce revenue metrics
getEnhancedCashFlowTransactions - Get enhanced cash flow report
getEnhancedInvoicesReport - Get enhanced invoices report
getLoanSummary - Get loan summaries
getRecurringRevenueMetrics - Get key subscription revenue metrics
listLoanTransactions - List loan transactions
requestRecurringRevenueMetrics - Generate key subscription revenue metrics

dataIntegrity

details - List data type data integrity
status - Get data integrity status
summary - Get data integrity summary

excelReports

generateExcelReport - Generate Excel report
getAccountingMarketingMetrics - Get marketing metrics report
getExcelReport - Download Excel report
getExcelReportGenerationStatus - 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 { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary(
        {
            companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
            sourceType: SourceType.Accounting,
        },
        {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        }
    );

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        retry_config: {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        },
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        sourceType: SourceType.Accounting,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Error Handling

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

Error Object	Status Code	Content Type
errors.SDKError	400-600	/

Example

import { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    let res;
    try {
        res = await sdk.reports.generateLoanSummary({
            companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
            sourceType: SourceType.Accounting,
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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 { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        serverIdx: 0,
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        sourceType: SourceType.Accounting,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Override Server URL Per-Client

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

import { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        serverURL: "https://api.codat.io",
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        sourceType: SourceType.Accounting,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios 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 AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { @codat/assess } from "CodatAssess";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new CodatAssess({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`authHeader`	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { CodatAssess } from "@codat/assess";
import { SourceType } from "@codat/assess/dist/sdk/models/operations";

async function run() {
    const sdk = new CodatAssess({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.reports.generateLoanSummary({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        sourceType: SourceType.Accounting,
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

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.