Skip to content

lending

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

lending

README.md

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: Our Lending solution 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 solution 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 solution | 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.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @codat/lending

PNPM

pnpm add @codat/lending

Bun

bun add @codat/lending

Yarn

yarn add @codat/lending

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "CodatLending": {
      "command": "npx",
      "args": [
        "-y", "--package", "@codat/lending",
        "--",
        "mcp", "start",
        "--auth-header", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "CodatLending": {
      "command": "npx",
      "args": [
        "-y", "--package", "@codat/lending",
        "--",
        "mcp", "start",
        "--auth-header", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @codat/lending -- mcp start --help

Example Usage

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatLending.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

AccountingBankData

AccountingBankData.Accounts

  • list - List bank accounts
  • get - Get bank account

AccountsPayable.BillCreditNotes

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

AccountsPayable.BillPayments

  • list - List bill payments
  • get - Get bill payment

AccountsPayable.Bills

AccountsPayable.Suppliers

AccountsReceivable.CreditNotes

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

AccountsReceivable.Customers

AccountsReceivable.DirectIncomes

AccountsReceivable.Invoices

AccountsReceivable.Payments

  • list - List payments
  • get - Get payment

AccountsReceivable.Reports

BankStatements

Banking.AccountBalances

  • list - List account balances

Banking.Accounts

  • list - List accounts
  • get - Get account

Banking.CategorizedStatement

  • get - Get categorized bank statement

Banking.TransactionCategories

  • list - List transaction categories
  • get - Get transaction category

Banking.Transactions

  • list - List transactions
  • get - Get bank transaction

Companies

CompanyInfo

Connections

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

DataIntegrity

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

ExcelReports

FileUpload

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

FinancialStatements.Accounts

  • list - List accounts
  • get - Get account

FinancialStatements.BalanceSheet

FinancialStatements.CashFlow

  • get - Get cash flow statement

FinancialStatements.ProfitAndLoss

Liabilities

LoanWriteback.Accounts

LoanWriteback.BankAccounts

LoanWriteback.BankTransactions

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

LoanWriteback.CreateOperations

  • get - Get create operation
  • list - List create operations

LoanWriteback.DirectCosts

LoanWriteback.Payments

LoanWriteback.SourceAccounts

LoanWriteback.Suppliers

LoanWriteback.Transfers

ManageReports

ManageData

ManageData.PullOperations

  • list - List pull operations
  • get - Get pull operation

ManageData.Refresh

Sales.Customers

  • list - List customers
  • get - Get customer

Sales.Disputes

  • list - List disputes
  • get - Get dispute

Sales.Locations

  • list - List locations
  • get - Get location

Sales.Metrics

Sales.Orders

  • list - List orders
  • get - Get order

Sales.PaymentMethods

  • list - List payment methods
  • get - Get payment method

Sales.Payments

  • list - List payments
  • get - Get payment

Sales.ProductCategories

  • list - List product categories
  • get - Get product category

Sales.Products

  • list - List products
  • get - Get product

Sales.Reports

Sales.Transactions

  • list - List transactions
  • get - Get transaction

Transactions.AccountTransactions

  • list - List account transactions
  • get - Get account transaction

Transactions.DirectCosts

Transactions.JournalEntries

  • list - List journal entries
  • get - Get journal entry

Transactions.Journals

  • list - List journals
  • get - Get journal

Transactions.Transfers

  • list - List transfers
  • get - Get transfer

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  await codatLending.fileUpload.upload({
    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
  });
}

run();

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 { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatLending.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

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 { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatLending.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Error Handling

CodatLendingError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { CodatLending } from "@codat/lending";
import * as errors from "@codat/lending/sdk/models/errors";

const codatLending = new CodatLending({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  try {
    const result = await codatLending.companies.list({
      query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
      orderBy: "-modifiedDate",
      tags: "region=uk && team=invoice-finance",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.CodatLendingError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorMessage) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.service); // string
        console.log(error.data$.error); // string
        console.log(error.data$.correlationId); // string
        console.log(error.data$.validation); // shared.ErrorValidation
      }
    }
  }
}

run();

Error Classes

Primary errors:

Less common errors (6)

Network errors:

Inherit from CodatLendingError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

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

import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  serverURL: "https://api.codat.io",
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatLending.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { CodatLending } from "@codat/lending";
import { HTTPClient } from "@codat/lending/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CodatLending({ httpClient: httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
authHeader apiKey API key

To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:

import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatLending.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { CodatLending } from "@codat/lending";

const sdk = new CodatLending({ debugLogger: console });

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