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

* Lending
* Endpoints
* SDK Installation
* Example Usage
* Requirements
* SDK Example Usage
* Available Resources and Operations
* Standalone functions
* File uploads
* Retries
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Debugging
* Support

SDK Installation

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

$3

``bash npm add @codat/lending`

`$3`

`bash pnpm add @codat/lending`

`$3`

`bash bun add @codat/lending`

`$3`

`bash yarn add @codat/lending`

`$3`

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:

`json { "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:

`json { "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:

`bash 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}".

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

For a full list of server arguments, run:

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

`Example Usage`



Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage
$3

`typescript 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
$3
* listTransactions - List bank account transactions
#### AccountingBankData.Accounts
* list - List bank accounts
* get - Get bank account
$3
* list - List bill credit notes
* get - Get bill credit note
$3
* list - List bill payments
* get - Get bill payment
$3
* list - List bills
* get - Get bill
* listAttachments - List bill attachments
* getAttachment - Get bill attachment
* downloadAttachment - Download bill attachment
$3
* list - List suppliers
* get - Get supplier
* listAttachments - List supplier attachments
* getAttachment - Get supplier attachment
* downloadAttachment - Download supplier attachment
$3
* list - List credit notes
* get - Get credit note
$3
* list - List customers
* get - Get customer
* listAttachments - List customer attachments
* getAttachment - Get customer attachment
* downloadAttachment - Download customer attachment
$3
* list - List direct incomes
* get - Get direct income
* getAttachment - Get direct income attachment
* downloadAttachment - Download direct income attachment
* listAttachments - List direct income attachments
$3
* listReconciled - List reconciled invoices
* list - List invoices
* get - Get invoice
* downloadPdf - Get invoice as PDF
* listAttachments - List invoice attachments
* getAttachment - Get invoice attachment
* downloadAttachment - Download invoice attachment
$3
* list - List payments
* get - Get payment
$3
* isAgedDebtorsAvailable - Aged debtors report available
* getAgedDebtors - Aged debtors report
* isAgedCreditorsAvailable - Aged creditors report available
* getAgedCreditors - Aged creditors report
$3
* getUploadConfiguration - Get upload configuration
* setUploadConfiguration - Set upload configuration
* startUploadSession - Start upload session
* uploadBankStatementData - Upload data
* endUploadSession - End upload session
$3
* list - List account balances
$3
* list - List accounts
* get - Get account
$3
* get - Get categorized bank statement
$3
* list - List transaction categories
* get - Get transaction category
$3
* list - List transactions
* get - Get bank transaction
$3
* list - List companies
* create - Create company
* replace - Replace company
* update - Update company
* delete - Delete a company
* get - Get company
$3
* getAccountingProfile - Get company accounting profile
* getCommerceProfile - Get company commerce profile
$3
* list - List connections
* create - Create connection
* get - Get connection
* delete - Delete connection
* unlink - Unlink connection
$3
* status - Get data integrity status
* summaries - Get data integrity summaries
* details - List data integrity details
$3
* generate - Generate Excel report
* getStatus - Get Excel report status
* download - Download Excel report
$3
* listUploaded - List all files uploaded by a company
* download - Download all files for a company
* upload - Upload files for a company
$3
* list - List accounts
* get - Get account
$3
* getCategorizedAccounts - Get categorized balance sheet statement
* get - Get balance sheet
$3
* get - Get cash flow statement
$3
* getCategorizedAccounts - Get categorized profit and loss statement
* get - Get profit and loss
$3
* generateLoanTransactions - Generate loan transactions report
* listLoanTransactions - List loan transactions
* generateLoanSummary - Generate loan summaries report
* getLoanSummary - Get loan summaries
$3
* getCreateModel - Get create account model
* create - Create account
$3
* getCreateUpdateModel - Get create/update bank account model
* create - Create bank account
$3
* getCreateModel - Get create bank account transactions model
* create - Create bank account transactions
$3
* get - Get create operation
* list - List create operations
$3
* getCreateModel - Get create direct cost model
* create - Create direct cost
$3
* getCreateModel - Get create payment model
* create - Create payment
$3
* create - Create source account
* listMappings - List bank feed account mappings
* createMapping - Create bank feed account mapping
$3
* getCreateUpdateModel - Get create/update supplier model
* create - Create supplier
$3
* getCreateModel - Get create transfer model
* create - Create transfer
$3
* generateReport - Generate report
* listReports - List reports
$3
* getStatus - Get data status
#### ManageData.PullOperations
* list - List pull operations
* get - Get pull operation
#### ManageData.Refresh
* allDataTypes - Refresh all data
* dataType - Refresh data type
$3
* list - List customers
* get - Get customer
$3
* list - List disputes
* get - Get dispute
$3
* list - List locations
* get - Get location
$3
* getRevenue - Get commerce revenue metrics
* getCustomerRetention - Get customer retention metrics
* getLifetimeValue - Get lifetime value metrics
$3
* list - List orders
* get - Get order
$3
* list - List payment methods
* get - Get payment method
$3
* list - List payments
* get - Get payment
$3
* list - List product categories
* get - Get product category
$3
* list - List products
* get - Get product
$3
* getOrders - Get orders report
* getRefunds - Get refunds report
$3
* list - List transactions
* get - Get transaction
$3
* list - List account transactions
* get - Get account transaction
$3
* list - List direct costs
* get - Get direct cost
* getAttachment - Get direct cost attachment
* downloadAttachment - Download direct cost attachment
* listAttachments - List direct cost attachments
$3
* list - List journal entries
* get - Get journal entry
$3
* list - List journals
* get - Get journal
$3
* 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 nativeopenAsBlob function in node:fs. > - Bun: The nativeBun.filefunction produces a file handle that can be used for streaming file uploads. > - Browsers: All supported browsers return an instance to aFile when reading the value from an element. > - Node.js v18: A file stream can be created using thefileFrom helper from fetch-blob/from.js.

`typescript 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:`typescript 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:`typescript 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. |

`$3`

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

`$3`


Primary errors:
*

CodatLendingError

: The base class for HTTP error responses.
  *

ErrorMessage: Your query

 parameter was not correctly formed.

Less common errors (6)

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

Inherit fromCodatLendingError: *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
$3

The default server can be overridden globally by passing a URL to the serverURL: stringoptional parameter when initializing the SDK client instance. For example:`typescript 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 HTTPClientthat wraps the native Fetch API. This client is a thin wrapper aroundfetchand 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 fetcherargument 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:

`typescript 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 nativefetch. 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`

`$3`

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | |authHeader | apiKey | API key |

To authenticate with the API the authHeaderparameter must be set when initializing the SDK client instance. For example:`typescript 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.

`typescript 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.

$3

Lending

Summary

Explore solution | See OpenAPI spec

Endpoints

SDK Installation

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

$3

``bash npm add @codat/lending`

`$3`

`bash pnpm add @codat/lending`

`$3`

`bash bun add @codat/lending`

`$3`

`bash yarn add @codat/lending`

`$3`

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:

`json { "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:

`json { "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:

`bash 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}".

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

For a full list of server arguments, run:

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

`Example Usage`



Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage
$3

`typescript 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
$3
* listTransactions - List bank account transactions
#### AccountingBankData.Accounts
* list - List bank accounts
* get - Get bank account
$3
* list - List bill credit notes
* get - Get bill credit note
$3
* list - List bill payments
* get - Get bill payment
$3
* list - List bills
* get - Get bill
* listAttachments - List bill attachments
* getAttachment - Get bill attachment
* downloadAttachment - Download bill attachment
$3
* list - List suppliers
* get - Get supplier
* listAttachments - List supplier attachments
* getAttachment - Get supplier attachment
* downloadAttachment - Download supplier attachment
$3
* list - List credit notes
* get - Get credit note
$3
* list - List customers
* get - Get customer
* listAttachments - List customer attachments
* getAttachment - Get customer attachment
* downloadAttachment - Download customer attachment
$3
* list - List direct incomes
* get - Get direct income
* getAttachment - Get direct income attachment
* downloadAttachment - Download direct income attachment
* listAttachments - List direct income attachments
$3
* listReconciled - List reconciled invoices
* list - List invoices
* get - Get invoice
* downloadPdf - Get invoice as PDF
* listAttachments - List invoice attachments
* getAttachment - Get invoice attachment
* downloadAttachment - Download invoice attachment
$3
* list - List payments
* get - Get payment
$3
* isAgedDebtorsAvailable - Aged debtors report available
* getAgedDebtors - Aged debtors report
* isAgedCreditorsAvailable - Aged creditors report available
* getAgedCreditors - Aged creditors report
$3
* getUploadConfiguration - Get upload configuration
* setUploadConfiguration - Set upload configuration
* startUploadSession - Start upload session
* uploadBankStatementData - Upload data
* endUploadSession - End upload session
$3
* list - List account balances
$3
* list - List accounts
* get - Get account
$3
* get - Get categorized bank statement
$3
* list - List transaction categories
* get - Get transaction category
$3
* list - List transactions
* get - Get bank transaction
$3
* list - List companies
* create - Create company
* replace - Replace company
* update - Update company
* delete - Delete a company
* get - Get company
$3
* getAccountingProfile - Get company accounting profile
* getCommerceProfile - Get company commerce profile
$3
* list - List connections
* create - Create connection
* get - Get connection
* delete - Delete connection
* unlink - Unlink connection
$3
* status - Get data integrity status
* summaries - Get data integrity summaries
* details - List data integrity details
$3
* generate - Generate Excel report
* getStatus - Get Excel report status
* download - Download Excel report
$3
* listUploaded - List all files uploaded by a company
* download - Download all files for a company
* upload - Upload files for a company
$3
* list - List accounts
* get - Get account
$3
* getCategorizedAccounts - Get categorized balance sheet statement
* get - Get balance sheet
$3
* get - Get cash flow statement
$3
* getCategorizedAccounts - Get categorized profit and loss statement
* get - Get profit and loss
$3
* generateLoanTransactions - Generate loan transactions report
* listLoanTransactions - List loan transactions
* generateLoanSummary - Generate loan summaries report
* getLoanSummary - Get loan summaries
$3
* getCreateModel - Get create account model
* create - Create account
$3
* getCreateUpdateModel - Get create/update bank account model
* create - Create bank account
$3
* getCreateModel - Get create bank account transactions model
* create - Create bank account transactions
$3
* get - Get create operation
* list - List create operations
$3
* getCreateModel - Get create direct cost model
* create - Create direct cost
$3
* getCreateModel - Get create payment model
* create - Create payment
$3
* create - Create source account
* listMappings - List bank feed account mappings
* createMapping - Create bank feed account mapping
$3
* getCreateUpdateModel - Get create/update supplier model
* create - Create supplier
$3
* getCreateModel - Get create transfer model
* create - Create transfer
$3
* generateReport - Generate report
* listReports - List reports
$3
* getStatus - Get data status
#### ManageData.PullOperations
* list - List pull operations
* get - Get pull operation
#### ManageData.Refresh
* allDataTypes - Refresh all data
* dataType - Refresh data type
$3
* list - List customers
* get - Get customer
$3
* list - List disputes
* get - Get dispute
$3
* list - List locations
* get - Get location
$3
* getRevenue - Get commerce revenue metrics
* getCustomerRetention - Get customer retention metrics
* getLifetimeValue - Get lifetime value metrics
$3
* list - List orders
* get - Get order
$3
* list - List payment methods
* get - Get payment method
$3
* list - List payments
* get - Get payment
$3
* list - List product categories
* get - Get product category
$3
* list - List products
* get - Get product
$3
* getOrders - Get orders report
* getRefunds - Get refunds report
$3
* list - List transactions
* get - Get transaction
$3
* list - List account transactions
* get - Get account transaction
$3
* list - List direct costs
* get - Get direct cost
* getAttachment - Get direct cost attachment
* downloadAttachment - Download direct cost attachment
* listAttachments - List direct cost attachments
$3
* list - List journal entries
* get - Get journal entry
$3
* list - List journals
* get - Get journal
$3
* 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.

`typescript 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`

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:`typescript import { CodatLending } from "@codat/lending";

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

console.log(result); }

run();

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:

`$3`

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

`$3`


Primary errors:
*

CodatLendingError

: The base class for HTTP error responses.
  *

ErrorMessage: Your query

 parameter was not correctly formed.

Less common errors (6)



Server Selection
$3

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 HTTPClient constructor takes an optional fetcherargument 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:

`typescript 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 nativefetch. 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; });

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

`Authentication`

`$3`

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | |authHeader | apiKey | API key |

To authenticate with the API the authHeaderparameter must be set when initializing the SDK client instance. For example:`typescript 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.

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

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

@codat/lending

Lending

Summary

Endpoints

Table of Contents

SDK Installation

$3

$3

$3

$3

$3

Example Usage

Requirements

SDK Example Usage

$3

Available Resources and Operations

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Standalone functions

File uploads

Retries

Error Handling

$3

$3

Server Selection

$3

Custom HTTP Client

`$3`

`$3`

`$3`

`$3`

`Example Usage`

`Available Resources and Operations`

`Retries`

`Error Handling`

`$3`

`$3`

`Custom HTTP Client`

`Authentication`

`$3`

`Debugging`

`$3`

`$3`

`$3`

`$3`

`Example Usage`

`Available Resources and Operations`