Codat.Lending 5.3.0

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.

SDK Installation

Nuget

dotnet add package Codat.Lending

Example Usage

SDK Example Usage

Example

using Codat.Lending;
using Codat.Lending.Models.Shared;
using System.Collections.Generic;

var sdk = new CodatLending(security: new Security() {
        AuthHeader = "Basic BASE_64_ENCODED(API_KEY)",
    });

CompanyRequestBody req = new CompanyRequestBody() {
    Description = "Requested early access to the new financing scheme.",
    Name = "Bank of Dave",
};

var res = await sdk.Companies.CreateAsync(req);

// handle response

Available Resources and Operations

Companies

• Create - Create company
• Delete - Delete a company
• Get - Get company
• List - List companies
• Update - Update company

Connections

• Create - Create connection
• Delete - Delete connection
• Get - Get connection
• List - List connections
• Unlink - Unlink connection

Transactions.AccountTransactions

• Get - Get account transaction
• List - List account transactions

Transactions.DirectCosts

• DownloadAttachment - Download direct cost attachment
• Get - Get direct cost
• GetAttachment - Get direct cost attachment
• List - List direct costs
• ListAttachments - List direct cost attachments

Transactions.Transfers

• Get - Get transfer
• List - List transfers

Transactions.JournalEntries

• Get - Get journal entry
• List - List journal entries

Transactions.Journals

• Get - Get journal
• List - List journals

AccountingBankData

• ListTransactions - List bank account transactions

AccountingBankData.Accounts

• Get - Get bank account
• List - List bank accounts

Banking.AccountBalances

• List - List account balances

Banking.Accounts

• Get - Get account
• List - List accounts

Banking.TransactionCategories

• Get - Get transaction category
• List - List transaction categories

Banking.Transactions

• Get - Get bank transaction
• List - List transactions

Banking.CategorizedStatement

• Get - Get categorized bank statement

AccountsPayable.Bills

• DownloadAttachment - Download bill attachment
• Get - Get bill
• GetAttachment - Get bill attachment
• List - List bills
• ListAttachments - List bill attachments

AccountsPayable.Suppliers

• DownloadAttachment - Download supplier attachment
• Get - Get supplier
• GetAttachment - Get supplier attachment
• List - List suppliers
• ListAttachments - List supplier attachments

AccountsPayable.BillCreditNotes

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

AccountsPayable.BillPayments

• Get - Get bill payment
• List - List bill payments

Sales.Customers

• Get - Get customer
• List - List customers

Sales.Disputes

• Get - Get dispute
• List - List disputes

Sales.Locations

• Get - Get location
• List - List locations

Sales.Orders

• Get - Get order
• List - List orders

Sales.PaymentMethods

• Get - Get payment method
• List - List payment methods

Sales.Payments

• Get - Get payment
• List - List payments

Sales.ProductCategories

• Get - Get product category
• List - List product categories

Sales.Products

• Get - Get product
• List - List products

Sales.Transactions

• Get - Get transaction
• List - List transactions

Sales.Metrics

• GetCustomerRetention - Get customer retention metrics
• GetLifetimeValue - Get lifetime value metrics
• GetRevenue - Get commerce revenue metrics

Sales.Reports

• GetOrders - Get orders report
• GetRefunds - Get refunds report

CompanyInfo

• GetAccountingProfile - Get company accounting profile
• GetCommerceProfile - Get company commerce profile

AccountsReceivable.Customers

• DownloadAttachment - Download customer attachment
• Get - Get customer
• GetAttachment - Get customer attachment
• List - List customers
• ListAttachments - List customer attachments

AccountsReceivable.DirectIncomes

• DownloadAttachment - Download direct income attachment
• Get - Get direct income
• GetAttachment - Get direct income attachment
• List - List direct incomes
• ListAttachments - List direct income attachments

AccountsReceivable.Invoices

• DownloadAttachment - Download invoice attachment
• DownloadPdf - Get invoice as PDF
• Get - Get invoice
• GetAttachment - Get invoice attachment
• List - List invoices
• ListAttachments - List invoice attachments
• ListReconciled - List reconciled invoices

AccountsReceivable.CreditNotes

• Get - Get credit note
• List - List credit notes

AccountsReceivable.Payments

• Get - Get payment
• List - List payments

AccountsReceivable.Reports

• GetAgedCreditors - Aged creditors report
• GetAgedDebtors - Aged debtors report
• IsAgedCreditorsAvailable - Aged creditors report available
• IsAgedDebtorsAvailable - Aged debtors report available

FileUpload

• Download - Download all files for a company
• ListUploaded - List all files uploaded by a company
• Upload - Upload files for a company

LoanWriteback.BankAccounts

• Create - Create bank account
• GetCreateUpdateModel - Get create/update bank account model

LoanWriteback.BankTransactions

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

LoanWriteback.Accounts

• Create - Create account
• GetCreateModel - Get create account model

LoanWriteback.DirectCosts

• Create - Create direct cost
• GetCreateModel - Get create direct cost model

LoanWriteback.Payments

• Create - Create payment
• GetCreateModel - Get create payment model

LoanWriteback.Suppliers

• Create - Create supplier
• GetCreateUpdateModel - Get create/update supplier model

LoanWriteback.Transfers

• Create - Create transfer
• GetCreateModel - Get create transfer model

LoanWriteback.CreateOperations

• Get - Get create operation
• List - List create operations

FinancialStatements.Accounts

• Get - Get account
• List - List accounts

FinancialStatements.BalanceSheet

• Get - Get balance sheet
• GetCategorizedAccounts - Get categorized balance sheet statement

FinancialStatements.CashFlow

• Get - Get cash flow statement

FinancialStatements.ProfitAndLoss

• Get - Get profit and loss
• GetCategorizedAccounts - Get categorized profit and loss statement

ManageData

• GetStatus - Get data status

ManageData.Refresh

• AllDataTypes - Refresh all data
• DataType - Refresh data type

ManageData.PullOperations

• Get - Get pull operation
• List - List pull operations

Liabilities

• GenerateLoanSummary - Generate loan summaries report
• GenerateLoanTransactions - Generate loan transactions report
• GetLoanSummary - Get loan summaries
• ListLoanTransactions - List loan transactions

DataIntegrity

• Details - List data integrity details
• Status - Get data integrity status
• Summaries - Get data integrity summaries

ExcelReports

• Download - Download Excel report
• Generate - Generate Excel report
• GetStatus - Get Excel report status

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://api.codat.io	None

Override Server URL Per-Client

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

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
authHeader	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

using Codat.Lending;
using Codat.Lending.Models.Shared;
using System.Collections.Generic;

var sdk = new CodatLending(security: new Security() {
        AuthHeader = "Basic BASE_64_ENCODED(API_KEY)",
    });

CompanyRequestBody req = new CompanyRequestBody() {
    Description = "Requested early access to the new financing scheme.",
    Name = "Bank of Dave",
};

var res = await sdk.Companies.CreateAsync(req);

// handle response

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy