⚠️
❤
npm
Sign UpSign In

@codat/lending
TypeScript icon, indicating that this package has built-in type declarations

7.3.0 • Public • Published

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 zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

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();

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

run();

Available Resources and Operations

Available methods

accountingBankData

accountingBankData.accounts

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

accountsPayable

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

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

banking

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

bankStatements

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

financialStatements.accounts

  • list - List accounts
  • get - Get account

financialStatements.balanceSheet

financialStatements.cashFlow

  • get - Get cash flow statement

financialStatements.profitAndLoss

liabilities

loanWriteback

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

manageData

manageData.pullOperations

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

manageData.refresh

manageReports

sales

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

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,
    },
  });

  // Handle the result
  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",
  });

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the sdk/models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the list method may throw the following errors:

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

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { CodatLending } from "@codat/lending";
import {
  ErrorMessage,
  SDKValidationError,
} from "@codat/lending/sdk/models/errors";

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

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

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ErrorMessage): {
        // Handle err.data$: ErrorMessageData
        console.error(err);
        return;
      }
      case (err instanceof ErrorMessage): {
        // Handle err.data$: ErrorMessageData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the sdk/models/errors/httpclienterrors.ts module:

HTTP Client Error Description
RequestAbortedError HTTP request was aborted by the client
RequestTimeoutError HTTP request timed out due to an AbortSignal signal
ConnectionError HTTP client was unable to make a request to a server
InvalidRequestError Any input used to create a request is invalid
UnexpectedClientError Unrecognised or unexpected error

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",
  });

  // Handle the result
  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 });

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",
  });

  // Handle the result
  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

Readme

Keywords

none