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.

Summary

Assess API: Codat's financial insights API

New to Codat?

Our Assess API reference is relevant only to our existing clients. Please reach out to your Codat contact so that we can find the right product for you.

Check that you have enabled the data types required by Assess for all of its features to work.

Endpoints

Endpoints	Description
Reports	Enriched reports and analyses of financial data.
Excel reports	Downloadable reports.
Data integrity	Match mutable accounting data with immutable banking data to increase confidence in financial data.

Read more...

See our OpenAPI spec

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Special Types

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/codatio/client-sdk-go/previous-versions/assess

Example Usage

SDK Example Usage

Example

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"log"
)

func main() {
	s := assess.New(
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

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

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

Special Types

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 retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/retry"
	"log"
	"pkg/models/operations"
)

func main() {
	s := assess.New(
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/retry"
	"log"
)

func main() {
	s := assess.New(
		assess.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

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

Example

package main

import (
	"context"
	"errors"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/sdkerrors"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"log"
)

func main() {
	s := assess.New(
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {

		var e *sdkerrors.ErrorMessage
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option 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

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"log"
)

func main() {
	s := assess.New(
		assess.WithServerIndex(0),
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"log"
)

func main() {
	s := assess.New(
		assess.WithServerURL("https://api.codat.io"),
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
AuthHeader	apiKey	API key

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"github.com/codatio/client-sdk-go/previous-versions/assess"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/operations"
	"github.com/codatio/client-sdk-go/previous-versions/assess/pkg/models/shared"
	"log"
)

func main() {
	s := assess.New(
		assess.WithSecurity(shared.Security{
			AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
		}),
	)

	ctx := context.Background()
	res, err := s.Reports.GenerateLoanSummary(ctx, operations.GenerateLoanSummaryRequest{
		CompanyID:  "8a210b68-6988-11ed-a1eb-0242ac120002",
		SourceType: operations.SourceTypeAccounting,
	})
	if err != nil {
		log.Fatal(err)
	}
	if res != nil {
		// handle response
	}
}

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