lending

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.

Summary

Lending API: Our Lending API helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently.

The Lending API is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers.

Explore product | See OpenAPI spec

Endpoints

Endpoints	Description
Companies	Create and manage your SMB users' companies.
Connections	Create new and manage existing data connections for a company.
Bank statements	Retrieve banking data from linked bank accounts.
Sales	Retrieve standardized sales data from a linked commerce software.
Financial statements	Financial data and reports from a linked accounting software.
Liabilities	Debt and other liabilities.
Accounts payable	Data from a linked accounting software representing money the business owes money to its suppliers.
Accounts receivable	Data from a linked accounting software representing money owed to the business for sold goods or services.
Transactions	Data from a linked accounting software representing transactions.
Company info	View company information fetched from the source platform.
Data integrity	Match mutable accounting data with immutable banking data to increase confidence in financial data.
Excel reports	Download reports in Excel format.
Manage data	Control how data is retrieved from an integration.
File upload	Endpoints to manage uploaded files.
Loan writeback	Implement the loan writeback procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.

SDK Installation

Getting started

JDK 11 or later is required.

The samples below show how a published SDK artifact is used:

Gradle:

implementation 'io.codat:lending:3.1.0'

Maven:

<dependency>
    <groupId>io.codat</groupId>
    <artifactId>lending</artifactId>
    <version>3.1.0</version>
</dependency>

How to build

After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.

If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):

On *nix:

./gradlew publishToMavenLocal -Pskip.signing

On Windows:

gradlew.bat publishToMavenLocal -Pskip.signing

Example Usage

SDK Example Usage

Example

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.shared.AccountCategoriesUpdatedWebhook;
import io.codat.lending.models.shared.AccountCategoriesUpdatedWebhookData;
import io.codat.lending.models.webhooks.AccountCategoriesUpdatedResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        CodatLending sdk = CodatLending.builder()
            .build();

        AccountCategoriesUpdatedWebhook req = AccountCategoriesUpdatedWebhook.builder()
                .alertId("a9367074-b5c3-42c4-9be4-be129f43577e")
                .clientId("bae71d36-ff47-420a-b4a6-f8c9ddf41140")
                .clientName("Bank of Dave")
                .companyId("8a210b68-6988-11ed-a1eb-0242ac120002")
                .data(AccountCategoriesUpdatedWebhookData.builder()
                    .modifiedDate("2022-10-23")
                    .build())
                .dataConnectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171")
                .message("Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.")
                .ruleId("70af3071-65d9-4ec3-b3cb-5283e8d55dac")
                .ruleType("Account Categories Updated")
                .build();

        AccountCategoriesUpdatedResponse res = sdk.accountCategoriesUpdated()
                .request(req)
                .call();

        // handle response
    }
}

Available Resources and Operations

Available methods

accountingBankData()

listTransactions - List bank account transactions

accountingBankData().accounts()

get - Get bank account
list - List bank accounts

accountsPayable()

accountsPayable().billCreditNotes()

get - Get bill credit note
list - List bill credit notes

accountsPayable().billPayments()

get - Get bill payment
list - List bill payments

accountsPayable().bills()

downloadAttachment - Download bill attachment
get - Get bill
getAttachment - Get bill attachment
list - List bills
listAttachments - List bill attachments

accountsPayable().suppliers()

downloadAttachment - Download supplier attachment
get - Get supplier
getAttachment - Get supplier attachment
list - List suppliers
listAttachments - List supplier attachments

accountsReceivable()

accountsReceivable().creditNotes()

get - Get credit note
list - List credit notes

accountsReceivable().customers()

downloadAttachment - Download customer attachment
get - Get customer
getAttachment - Get customer attachment
list - List customers
listAttachments - List customer attachments

accountsReceivable().directIncomes()

downloadAttachment - Download direct income attachment
get - Get direct income
getAttachment - Get direct income attachment
list - List direct incomes
listAttachments - List direct income attachments

accountsReceivable().invoices()

downloadAttachment - Download invoice attachment
downloadPdf - Get invoice as PDF
get - Get invoice
getAttachment - Get invoice attachment
list - List invoices
listAttachments - List invoice attachments
listReconciled - List reconciled invoices

accountsReceivable().payments()

get - Get payment
list - List payments

accountsReceivable().reports()

getAgedCreditors - Aged creditors report
getAgedDebtors - Aged debtors report
isAgedCreditorsAvailable - Aged creditors report available
isAgedDebtorsAvailable - Aged debtors report available

banking()

banking().accountBalances()

list - List account balances

banking().accounts()

get - Get account
list - List accounts

banking().categorizedStatement()

get - Get categorized bank statement

banking().transactionCategories()

get - Get transaction category
list - List transaction categories

banking().transactions()

get - Get bank transaction
list - List transactions

bankStatements()

endUploadSession - End upload session
getUploadConfiguration - Get upload configuration
setUploadConfiguration - Set upload configuration
startUploadSession - Start upload session
uploadBankStatementData - Upload data

companies()

create - Create company
delete - Delete a company
get - Get company
list - List companies
update - Update company

companyInfo()

getAccountingProfile - Get company accounting profile
getCommerceProfile - Get company commerce profile

connections()

create - Create connection
delete - Delete connection
get - Get connection
list - List connections
unlink - Unlink connection

dataIntegrity()

details - List data integrity details
status - Get data integrity status
summaries - Get data integrity summaries

excelReports()

download - Download Excel report
generate - Generate Excel report
getStatus - Get Excel report status

fileUpload()

download - Download all files for a company
listUploaded - List all files uploaded by a company
upload - Upload files for a company

financialStatements()

financialStatements().accounts()

get - Get account
list - List accounts

financialStatements().balanceSheet()

get - Get balance sheet
getCategorizedAccounts - Get categorized balance sheet statement

financialStatements().cashFlow()

get - Get cash flow statement

financialStatements().profitAndLoss()

get - Get profit and loss
getCategorizedAccounts - Get categorized profit and loss statement

liabilities()

generateLoanSummary - Generate loan summaries report
generateLoanTransactions - Generate loan transactions report
getLoanSummary - Get loan summaries
listLoanTransactions - List loan transactions

loanWriteback()

loanWriteback().accounts()

create - Create account
getCreateModel - Get create account model

loanWriteback().bankAccounts()

create - Create bank account
getCreateUpdateModel - Get create/update bank account model

loanWriteback().bankTransactions()

create - Create bank account transactions
getCreateModel - Get create bank account transactions model

loanWriteback().createOperations()

get - Get create operation
list - List create operations

loanWriteback().directCosts()

create - Create direct cost
getCreateModel - Get create direct cost model

loanWriteback().payments()

create - Create payment
getCreateModel - Get create payment model

loanWriteback().sourceAccounts()

create - Create source account
createMapping - Create bank feed account mapping
listMappings - List bank feed account mappings

loanWriteback().suppliers()

create - Create supplier
getCreateUpdateModel - Get create/update supplier model

loanWriteback().transfers()

create - Create transfer
getCreateModel - Get create transfer model

manageData()

getStatus - Get data status

manageData().pullOperations()

get - Get pull operation
list - List pull operations

manageData().refresh()

allDataTypes - Refresh all data
dataType - Refresh data type

manageReports()

generateReport - Generate report
listReports - List reports

sales()

sales().customers()

get - Get customer
list - List customers

sales().disputes()

get - Get dispute
list - List disputes

sales().locations()

get - Get location
list - List locations

sales().metrics()

getCustomerRetention - Get customer retention metrics
getLifetimeValue - Get lifetime value metrics
getRevenue - Get commerce revenue metrics

sales().orders()

get - Get order
list - List orders

sales().paymentMethods()

get - Get payment method
list - List payment methods

sales().payments()

get - Get payment
list - List payments

sales().productCategories()

get - Get product category
list - List product categories

sales().products()

get - Get product
list - List products

sales().reports()

getOrders - Get orders report
getRefunds - Get refunds report

sales().transactions()

get - Get transaction
list - List transactions

transactions()

transactions().accountTransactions()

get - Get account transaction
list - List account transactions

transactions().directCosts()

downloadAttachment - Download direct cost attachment
get - Get direct cost
getAttachment - Get direct cost attachment
list - List direct costs
listAttachments - List direct cost attachments

transactions().journalEntries()

get - Get journal entry
list - List journal entries

transactions().journals()

get - Get journal
list - List journals

transactions().transfers()

get - Get transfer
list - List transfers

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, you can provide a RetryConfig object through the retryConfig builder method:

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.errors.ErrorMessage;
import io.codat.lending.models.operations.CreateCompanyResponse;
import io.codat.lending.models.shared.CompanyRequestBody;
import io.codat.lending.models.shared.Security;
import io.codat.lending.utils.BackoffStrategy;
import io.codat.lending.utils.RetryConfig;
import java.lang.Exception;
import java.util.concurrent.TimeUnit;

public class Application {

    public static void main(String[] args) throws ErrorMessage, Exception {

        CodatLending sdk = CodatLending.builder()
                .security(Security.builder()
                    .authHeader("Basic BASE_64_ENCODED(API_KEY)")
                    .build())
            .build();

        CompanyRequestBody req = CompanyRequestBody.builder()
                .name("Technicalium")
                .description("Requested early access to the new financing scheme.")
                .build();

        CreateCompanyResponse res = sdk.companies().create()
                .request(req)
                .retryConfig(RetryConfig.builder()
                    .backoff(BackoffStrategy.builder()
                        .initialInterval(1L, TimeUnit.MILLISECONDS)
                        .maxInterval(50L, TimeUnit.MILLISECONDS)
                        .maxElapsedTime(1000L, TimeUnit.MILLISECONDS)
                        .baseFactor(1.1)
                        .jitterFactor(0.15)
                        .retryConnectError(false)
                        .build())
                    .build())
                .call();

        if (res.company().isPresent()) {
            // handle response
        }
    }
}

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

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.errors.ErrorMessage;
import io.codat.lending.models.operations.CreateCompanyResponse;
import io.codat.lending.models.shared.CompanyRequestBody;
import io.codat.lending.models.shared.Security;
import io.codat.lending.utils.BackoffStrategy;
import io.codat.lending.utils.RetryConfig;
import java.lang.Exception;
import java.util.concurrent.TimeUnit;

public class Application {

    public static void main(String[] args) throws ErrorMessage, Exception {

        CodatLending sdk = CodatLending.builder()
                .retryConfig(RetryConfig.builder()
                    .backoff(BackoffStrategy.builder()
                        .initialInterval(1L, TimeUnit.MILLISECONDS)
                        .maxInterval(50L, TimeUnit.MILLISECONDS)
                        .maxElapsedTime(1000L, TimeUnit.MILLISECONDS)
                        .baseFactor(1.1)
                        .jitterFactor(0.15)
                        .retryConnectError(false)
                        .build())
                    .build())
                .security(Security.builder()
                    .authHeader("Basic BASE_64_ENCODED(API_KEY)")
                    .build())
            .build();

        CompanyRequestBody req = CompanyRequestBody.builder()
                .name("Technicalium")
                .description("Requested early access to the new financing scheme.")
                .build();

        CreateCompanyResponse res = sdk.companies().create()
                .request(req)
                .call();

        if (res.company().isPresent()) {
            // handle response
        }
    }
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will throw a models/errors/SDKError exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create method throws the following exceptions:

Error Type	Status Code	Content Type
models/errors/ErrorMessage	400, 401, 402, 403, 429, 500, 503	application/json
models/errors/SDKError	4XX, 5XX	/

Example

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.errors.ErrorMessage;
import io.codat.lending.models.operations.CreateCompanyResponse;
import io.codat.lending.models.shared.CompanyRequestBody;
import io.codat.lending.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorMessage, Exception {

        CodatLending sdk = CodatLending.builder()
                .security(Security.builder()
                    .authHeader("Basic BASE_64_ENCODED(API_KEY)")
                    .build())
            .build();

        CompanyRequestBody req = CompanyRequestBody.builder()
                .name("Technicalium")
                .description("Requested early access to the new financing scheme.")
                .build();

        CreateCompanyResponse res = sdk.companies().create()
                .request(req)
                .call();

        if (res.company().isPresent()) {
            // handle response
        }
    }
}

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally using the .serverURL(String serverUrl) builder method when initializing the SDK client instance. For example:

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.errors.ErrorMessage;
import io.codat.lending.models.operations.CreateCompanyResponse;
import io.codat.lending.models.shared.CompanyRequestBody;
import io.codat.lending.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorMessage, Exception {

        CodatLending sdk = CodatLending.builder()
                .serverURL("https://api.codat.io")
                .security(Security.builder()
                    .authHeader("Basic BASE_64_ENCODED(API_KEY)")
                    .build())
            .build();

        CompanyRequestBody req = CompanyRequestBody.builder()
                .name("Technicalium")
                .description("Requested early access to the new financing scheme.")
                .build();

        CreateCompanyResponse res = sdk.companies().create()
                .request(req)
                .call();

        if (res.company().isPresent()) {
            // handle response
        }
    }
}

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 builder method when initializing the SDK client instance. For example:

package hello.world;

import io.codat.lending.CodatLending;
import io.codat.lending.models.errors.ErrorMessage;
import io.codat.lending.models.operations.CreateCompanyResponse;
import io.codat.lending.models.shared.CompanyRequestBody;
import io.codat.lending.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorMessage, Exception {

        CodatLending sdk = CodatLending.builder()
                .security(Security.builder()
                    .authHeader("Basic BASE_64_ENCODED(API_KEY)")
                    .build())
            .build();

        CompanyRequestBody req = CompanyRequestBody.builder()
                .name("Technicalium")
                .description("Requested early access to the new financing scheme.")
                .build();

        CreateCompanyResponse res = sdk.companies().create()
                .request(req)
                .call();

        if (res.company().isPresent()) {
            // 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.

Name	Name	Last commit message	Last commit date
parent directory ..
.speakeasy	.speakeasy
docs	docs
gradle/wrapper	gradle/wrapper
src/main/java/io/codat/lending	src/main/java/io/codat/lending
.gitattributes	.gitattributes
.gitignore	.gitignore
CONTRIBUTING.md	CONTRIBUTING.md
README.md	README.md
RELEASES.md	RELEASES.md
USAGE.md	USAGE.md
build-extras.gradle	build-extras.gradle
build.gradle	build.gradle
gradlew	gradlew
gradlew.bat	gradlew.bat
settings.gradle	settings.gradle

Search code, repositories, users, issues, pull requests...

FilesExpand file tree

lending

Directory actions

More options

Directory actions

More options

Latest commit

History

lending

Folders and files

parent directory

Lending

Summary

Endpoints

Table of Contents

SDK Installation

Getting started

How to build

Example Usage

SDK Example Usage

Example

Available Resources and Operations

Retries

Error Handling

Example

Server Selection

Override Server URL Per-Client

Authentication

Per-Client Security Schemes

Support

Library generated by Speakeasy

Expand file tree