<!-- Start Codat Library Description --> 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 decisi
npm install @codat/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.
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 | 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. |
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
``bash`
npm add @codat/lending
`bash`
pnpm add @codat/lending
`bash`
bun add @codat/lending
`bash`
yarn add @codat/lending
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
For supported JavaScript runtimes, please consult RUNTIMES.md.
`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 methods
* listTransactions - List bank account transactions
#### AccountingBankData.Accounts
* list - List bank accounts
* get - Get bank account
* list - List bill credit notes
* get - Get bill credit note
* list - List bill payments
* get - Get bill payment
* list - List bills
* get - Get bill
* listAttachments - List bill attachments
* getAttachment - Get bill attachment
* downloadAttachment - Download bill attachment
* list - List suppliers
* get - Get supplier
* listAttachments - List supplier attachments
* getAttachment - Get supplier attachment
* downloadAttachment - Download supplier attachment
* list - List credit notes
* get - Get credit note
* list - List customers
* get - Get customer
* listAttachments - List customer attachments
* getAttachment - Get customer attachment
* downloadAttachment - Download customer attachment
* list - List direct incomes
* get - Get direct income
* getAttachment - Get direct income attachment
* downloadAttachment - Download direct income attachment
* listAttachments - List direct income attachments
* 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
* list - List payments
* get - Get payment
* isAgedDebtorsAvailable - Aged debtors report available
* getAgedDebtors - Aged debtors report
* isAgedCreditorsAvailable - Aged creditors report available
* getAgedCreditors - Aged creditors report
* getUploadConfiguration - Get upload configuration
* setUploadConfiguration - Set upload configuration
* startUploadSession - Start upload session
* uploadBankStatementData - Upload data
* endUploadSession - End upload session
* list - List account balances
* list - List accounts
* get - Get account
* get - Get categorized bank statement
* list - List transaction categories
* get - Get transaction category
* list - List transactions
* get - Get bank transaction
* list - List companies
* create - Create company
* replace - Replace company
* update - Update company
* delete - Delete a company
* get - Get company
* getAccountingProfile - Get company accounting profile
* getCommerceProfile - Get company commerce profile
* list - List connections
* create - Create connection
* get - Get connection
* delete - Delete connection
* unlink - Unlink connection
* status - Get data integrity status
* summaries - Get data integrity summaries
* details - List data integrity details
* generate - Generate Excel report
* getStatus - Get Excel report status
* download - Download Excel report
* listUploaded - List all files uploaded by a company
* download - Download all files for a company
* upload - Upload files for a company
* list - List accounts
* get - Get account
* getCategorizedAccounts - Get categorized balance sheet statement
* get - Get balance sheet
* get - Get cash flow statement
* getCategorizedAccounts - Get categorized profit and loss statement
* get - Get profit and loss
* generateLoanTransactions - Generate loan transactions report
* listLoanTransactions - List loan transactions
* generateLoanSummary - Generate loan summaries report
* getLoanSummary - Get loan summaries
* getCreateModel - Get create account model
* create - Create account
* getCreateUpdateModel - Get create/update bank account model
* create - Create bank account
* getCreateModel - Get create bank account transactions model
* create - Create bank account transactions
* get - Get create operation
* list - List create operations
* getCreateModel - Get create direct cost model
* create - Create direct cost
* getCreateModel - Get create payment model
* create - Create payment
* create - Create source account
* listMappings - List bank feed account mappings
* createMapping - Create bank feed account mapping
* getCreateUpdateModel - Get create/update supplier model
* create - Create supplier
* getCreateModel - Get create transfer model
* create - Create transfer
* generateReport - Generate report
* listReports - List reports
* getStatus - Get data status
#### ManageData.PullOperations
* list - List pull operations
* get - Get pull operation
#### ManageData.Refresh
* allDataTypes - Refresh all data
* dataType - Refresh data type
* list - List customers
* get - Get customer
* list - List disputes
* get - Get dispute
* list - List locations
* get - Get location
* getRevenue - Get commerce revenue metrics
* getCustomerRetention - Get customer retention metrics
* getLifetimeValue - Get lifetime value metrics
* list - List orders
* get - Get order
* list - List payment methods
* get - Get payment method
* list - List payments
* get - Get payment
* list - List product categories
* get - Get product category
* list - List products
* get - Get product
* getOrders - Get orders report
* getRefunds - Get refunds report
* list - List transactions
* get - Get transaction
* list - List account transactions
* get - Get account transaction
* list - List direct costs
* get - Get direct cost
* getAttachment - Get direct cost attachment
* downloadAttachment - Download direct cost attachment
* listAttachments - List direct cost attachments
* list - List journal entries
* get - Get journal entry
* list - List journals
* get - Get journal
* list - List transfers
* get - Get transfer
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.
- accountingBankDataAccountsGet - Get bank account
- accountingBankDataAccountsList - List bank accounts
- accountingBankDataListTransactions - List bank account transactions
- accountsPayableBillCreditNotesGet - Get bill credit note
- accountsPayableBillCreditNotesList - List bill credit notes
- accountsPayableBillPaymentsGet - Get bill payment
- accountsPayableBillPaymentsList - List bill payments
- accountsPayableBillsDownloadAttachment - Download bill attachment
- accountsPayableBillsGet - Get bill
- accountsPayableBillsGetAttachment - Get bill attachment
- accountsPayableBillsList - List bills
- accountsPayableBillsListAttachments - List bill attachments
- accountsPayableSuppliersDownloadAttachment - Download supplier attachment
- accountsPayableSuppliersGet - Get supplier
- accountsPayableSuppliersGetAttachment - Get supplier attachment
- accountsPayableSuppliersList - List suppliers
- accountsPayableSuppliersListAttachments - List supplier attachments
- accountsReceivableCreditNotesGet - Get credit note
- accountsReceivableCreditNotesList - List credit notes
- accountsReceivableCustomersDownloadAttachment - Download customer attachment
- accountsReceivableCustomersGet - Get customer
- accountsReceivableCustomersGetAttachment - Get customer attachment
- accountsReceivableCustomersList - List customers
- accountsReceivableCustomersListAttachments - List customer attachments
- accountsReceivableDirectIncomesDownloadAttachment - Download direct income attachment
- accountsReceivableDirectIncomesGet - Get direct income
- accountsReceivableDirectIncomesGetAttachment - Get direct income attachment
- accountsReceivableDirectIncomesList - List direct incomes
- accountsReceivableDirectIncomesListAttachments - List direct income attachments
- accountsReceivableInvoicesDownloadAttachment - Download invoice attachment
- accountsReceivableInvoicesDownloadPdf - Get invoice as PDF
- accountsReceivableInvoicesGet - Get invoice
- accountsReceivableInvoicesGetAttachment - Get invoice attachment
- accountsReceivableInvoicesList - List invoices
- accountsReceivableInvoicesListAttachments - List invoice attachments
- accountsReceivableInvoicesListReconciled - List reconciled invoices
- accountsReceivablePaymentsGet - Get payment
- accountsReceivablePaymentsList - List payments
- accountsReceivableReportsGetAgedCreditors - Aged creditors report
- accountsReceivableReportsGetAgedDebtors - Aged debtors report
- accountsReceivableReportsIsAgedCreditorsAvailable - Aged creditors report available
- accountsReceivableReportsIsAgedDebtorsAvailable - Aged debtors report available
- bankingAccountBalancesList - List account balances
- bankingAccountsGet - Get account
- bankingAccountsList - List accounts
- bankingCategorizedStatementGet - Get categorized bank statement
- bankingTransactionCategoriesGet - Get transaction category
- bankingTransactionCategoriesList - List transaction categories
- bankingTransactionsGet - Get bank transaction
- bankingTransactionsList - List transactions
- bankStatementsEndUploadSession - End upload session
- bankStatementsGetUploadConfiguration - Get upload configuration
- bankStatementsSetUploadConfiguration - Set upload configuration
- bankStatementsStartUploadSession - Start upload session
- bankStatementsUploadBankStatementData - Upload data
- companiesCreate - Create company
- companiesDelete - Delete a company
- companiesGet - Get company
- companiesList - List companies
- companiesReplace - Replace company
- companiesUpdate - Update company
- companyInfoGetAccountingProfile - Get company accounting profile
- companyInfoGetCommerceProfile - Get company commerce profile
- connectionsCreate - Create connection
- connectionsDelete - Delete connection
- connectionsGet - Get connection
- connectionsList - List connections
- connectionsUnlink - Unlink connection
- dataIntegrityDetails - List data integrity details
- dataIntegrityStatus - Get data integrity status
- dataIntegritySummaries - Get data integrity summaries
- excelReportsDownload - Download Excel report
- excelReportsGenerate - Generate Excel report
- excelReportsGetStatus - Get Excel report status
- fileUploadDownload - Download all files for a company
- fileUploadListUploaded - List all files uploaded by a company
- fileUploadUpload - Upload files for a company
- financialStatementsAccountsGet - Get account
- financialStatementsAccountsList - List accounts
- financialStatementsBalanceSheetGet - Get balance sheet
- financialStatementsBalanceSheetGetCategorizedAccounts - Get categorized balance sheet statement
- financialStatementsCashFlowGet - Get cash flow statement
- financialStatementsProfitAndLossGet - Get profit and loss
- financialStatementsProfitAndLossGetCategorizedAccounts - Get categorized profit and loss statement
- liabilitiesGenerateLoanSummary - Generate loan summaries report
- liabilitiesGenerateLoanTransactions - Generate loan transactions report
- liabilitiesGetLoanSummary - Get loan summaries
- liabilitiesListLoanTransactions - List loan transactions
- loanWritebackAccountsCreate - Create account
- loanWritebackAccountsGetCreateModel - Get create account model
- loanWritebackBankAccountsCreate - Create bank account
- loanWritebackBankAccountsGetCreateUpdateModel - Get create/update bank account model
- loanWritebackBankTransactionsCreate - Create bank account transactions
- loanWritebackBankTransactionsGetCreateModel - Get create bank account transactions model
- loanWritebackCreateOperationsGet - Get create operation
- loanWritebackCreateOperationsList - List create operations
- loanWritebackDirectCostsCreate - Create direct cost
- loanWritebackDirectCostsGetCreateModel - Get create direct cost model
- loanWritebackPaymentsCreate - Create payment
- loanWritebackPaymentsGetCreateModel - Get create payment model
- loanWritebackSourceAccountsCreate - Create source account
- loanWritebackSourceAccountsCreateMapping - Create bank feed account mapping
- loanWritebackSourceAccountsListMappings - List bank feed account mappings
- loanWritebackSuppliersCreate - Create supplier
- loanWritebackSuppliersGetCreateUpdateModel - Get create/update supplier model
- loanWritebackTransfersCreate - Create transfer
- loanWritebackTransfersGetCreateModel - Get create transfer model
- manageDataGetStatus - Get data status
- manageDataPullOperationsGet - Get pull operation
- manageDataPullOperationsList - List pull operations
- manageDataRefreshAllDataTypes - Refresh all data
- manageDataRefreshDataType - Refresh data type
- manageReportsGenerateReport - Generate report
- manageReportsListReports - List reports
- salesCustomersGet - Get customer
- salesCustomersList - List customers
- salesDisputesGet - Get dispute
- salesDisputesList - List disputes
- salesLocationsGet - Get location
- salesLocationsList - List locations
- salesMetricsGetCustomerRetention - Get customer retention metrics
- salesMetricsGetLifetimeValue - Get lifetime value metrics
- salesMetricsGetRevenue - Get commerce revenue metrics
- salesOrdersGet - Get order
- salesOrdersList - List orders
- salesPaymentMethodsGet - Get payment method
- salesPaymentMethodsList - List payment methods
- salesPaymentsGet - Get payment
- salesPaymentsList - List payments
- salesProductCategoriesGet - Get product category
- salesProductCategoriesList - List product categories
- salesProductsGet - Get product
- salesProductsList - List products
- salesReportsGetOrders - Get orders report
- salesReportsGetRefunds - Get refunds report
- salesTransactionsGet - Get transaction
- salesTransactionsList - List transactions
- transactionsAccountTransactionsGet - Get account transaction
- transactionsAccountTransactionsList - List account transactions
- transactionsDirectCostsDownloadAttachment - Download direct cost attachment
- transactionsDirectCostsGet - Get direct cost
- transactionsDirectCostsGetAttachment - Get direct cost attachment
- transactionsDirectCostsList - List direct costs
- transactionsDirectCostsListAttachments - List direct cost attachments
- transactionsJournalEntriesGet - Get journal entry
- transactionsJournalEntriesList - List journal entries
- transactionsJournalsGet - Get journal
- transactionsJournalsList - List journals
- transactionsTransfersGet - Get transfer
- transactionsTransfersList - List transfers
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.file
> - Bun: The native function produces a file handle that can be used for streaming file uploads.File
> - Browsers: All supported browsers return an instance to a when reading the value from an element.fileFrom
> - Node.js v18: A file stream can be created using the 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();
`
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();
`
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. |
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)
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.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
$3
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:
`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
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:`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 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
$3
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:
`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 });
``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.