@codat/lending 2.1.0 → 3.2.0

package/docs/sdks/accountsreceivablecustomers/README.md

@@ -1,4 +1,4 @@
-# accountsReceivableCustomers
+# AccountsReceivable.Customers
 
 ### Available Operations
 
@@ -29,7 +29,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableCustomers.downloadAttachment({
+sdk.accountsReceivable.customers.downloadAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -78,7 +78,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableCustomers.get({
+sdk.accountsReceivable.customers.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   customerId: "quo",
 }).then((res: GetAccountingCustomerResponse) => {
@@ -123,7 +123,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableCustomers.getAttachment({
+sdk.accountsReceivable.customers.getAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -170,7 +170,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableCustomers.list({
+sdk.accountsReceivable.customers.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   orderBy: "-modifiedDate",
   page: 1,
@@ -218,7 +218,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableCustomers.listAttachments({
+sdk.accountsReceivable.customers.listAttachments({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   customerId: "at",

package/docs/sdks/accountsreceivabledirectincomes/README.md

@@ -1,4 +1,4 @@
-# accountsReceivableDirectIncomes
+# AccountsReceivable.DirectIncomes
 
 ### Available Operations
 
@@ -29,7 +29,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableDirectIncomes.downloadAttachment({
+sdk.accountsReceivable.directIncomes.downloadAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -78,7 +78,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableDirectIncomes.get({
+sdk.accountsReceivable.directIncomes.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   directIncomeId: "molestiae",
@@ -124,7 +124,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableDirectIncomes.getAttachment({
+sdk.accountsReceivable.directIncomes.getAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -172,7 +172,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableDirectIncomes.list({
+sdk.accountsReceivable.directIncomes.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   orderBy: "-modifiedDate",
@@ -221,7 +221,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableDirectIncomes.listAttachments({
+sdk.accountsReceivable.directIncomes.listAttachments({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   directIncomeId: "totam",

package/docs/sdks/accountsreceivableinvoices/README.md

@@ -1,4 +1,4 @@
-# accountsReceivableInvoices
+# AccountsReceivable.Invoices
 
 ### Available Operations
 
@@ -31,7 +31,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.downloadAttachment({
+sdk.accountsReceivable.invoices.downloadAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -73,7 +73,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.downloadPdf({
+sdk.accountsReceivable.invoices.downloadPdf({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   invoiceId: "dolorum",
 }).then((res: DownloadAccountingInvoicePdfResponse) => {
@@ -119,7 +119,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.get({
+sdk.accountsReceivable.invoices.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   invoiceId: "dicta",
 }).then((res: GetAccountingInvoiceResponse) => {
@@ -164,7 +164,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.getAttachment({
+sdk.accountsReceivable.invoices.getAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -217,7 +217,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.list({
+sdk.accountsReceivable.invoices.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   orderBy: "-modifiedDate",
   page: 1,
@@ -265,7 +265,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.listAttachments({
+sdk.accountsReceivable.invoices.listAttachments({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   invoiceId: "occaecati",
@@ -306,7 +306,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableInvoices.listReconciled({
+sdk.accountsReceivable.invoices.listReconciled({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   page: 1,
   pageSize: 100,

package/docs/sdks/accountsreceivablepayments/README.md

@@ -1,4 +1,4 @@
-# accountsReceivablePayments
+# AccountsReceivable.Payments
 
 ### Available Operations
 
@@ -28,7 +28,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivablePayments.get({
+sdk.accountsReceivable.payments.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   paymentId: "deleniti",
 }).then((res: GetAccountingPaymentResponse) => {
@@ -73,7 +73,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivablePayments.list({
+sdk.accountsReceivable.payments.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   orderBy: "-modifiedDate",
   page: 1,

package/docs/sdks/accountsreceivablereports/README.md

@@ -1,4 +1,4 @@
-# accountsReceivableReports
+# AccountsReceivable.Reports
 
 ### Available Operations
 
@@ -24,7 +24,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableReports.getAgedCreditors({
+sdk.accountsReceivable.reports.getAgedCreditors({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   numberOfPeriods: 12,
   periodLengthDays: 30,
@@ -67,7 +67,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableReports.getAgedDebtors({
+sdk.accountsReceivable.reports.getAgedDebtors({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   numberOfPeriods: 12,
   periodLengthDays: 30,
@@ -109,7 +109,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableReports.isAgedCreditorsAvailable({
+sdk.accountsReceivable.reports.isAgedCreditorsAvailable({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 }).then((res: IsAgedCreditorsReportAvailableResponse) => {
   if (res.statusCode == 200) {
@@ -148,7 +148,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.accountsReceivableReports.isAgedDebtorsAvailable({
+sdk.accountsReceivable.reports.isAgedDebtorsAvailable({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 }).then((res: IsAgedDebtorsReportAvailableResponse) => {
   if (res.statusCode == 200) {

package/docs/sdks/banking/README.md

@@ -1,4 +1,4 @@
-# banking
+# Banking
 
 ### Available Operations
 

package/docs/sdks/bankingaccountbalances/README.md

@@ -1,4 +1,4 @@
-# bankingAccountBalances
+# Banking.AccountBalances
 
 ### Available Operations
 
@@ -25,7 +25,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.bankingAccountBalances.list({
+sdk.banking.accountBalances.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   orderBy: "-modifiedDate",

package/docs/sdks/bankingcategorizedstatement/README.md

@@ -1,4 +1,4 @@
-# bankingCategorizedStatement
+# Banking.CategorizedStatement
 
 ### Available Operations
 
@@ -24,7 +24,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.bankingCategorizedStatement.get({
+sdk.banking.categorizedStatement.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   page: 1,
   pageSize: 100,

package/docs/sdks/bankingtransactioncategories/README.md

@@ -1,4 +1,4 @@
-# bankingTransactionCategories
+# Banking.TransactionCategories
 
 ### Available Operations
 
@@ -28,7 +28,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.bankingTransactionCategories.get({
+sdk.banking.transactionCategories.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   transactionCategoryId: "molestiae",
@@ -74,7 +74,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.bankingTransactionCategories.list({
+sdk.banking.transactionCategories.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   orderBy: "-modifiedDate",

package/docs/sdks/companies/README.md

@@ -1,4 +1,4 @@
-# companies
+# Companies
 
 ## Overview
 

package/docs/sdks/companyinfo/README.md

@@ -1,4 +1,4 @@
-# companyInfo
+# CompanyInfo
 
 ## Overview
 

package/docs/sdks/connections/README.md

@@ -1,4 +1,4 @@
-# connections
+# Connections
 
 ## Overview
 

package/docs/sdks/dataintegrity/README.md

@@ -1,4 +1,4 @@
-# dataIntegrity
+# DataIntegrity
 
 ## Overview
 

package/docs/sdks/excelreports/README.md

@@ -1,4 +1,4 @@
-# excelReports
+# ExcelReports
 
 ## Overview
 

package/docs/sdks/fileupload/README.md

@@ -1,4 +1,4 @@
-# fileUpload
+# FileUpload
 
 ## Overview
 

package/docs/sdks/financialstatements/README.md

@@ -1,4 +1,4 @@
-# financialStatements
+# FinancialStatements
 
 ### Available Operations
 

package/docs/sdks/financialstatementsaccounts/README.md

@@ -1,4 +1,4 @@
-# financialStatementsAccounts
+# FinancialStatements.Accounts
 
 ### Available Operations
 
@@ -28,7 +28,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsAccounts.get({
+sdk.financialStatements.accounts.get({
   accountId: "cum",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 }).then((res: GetAccountingAccountResponse) => {
@@ -72,7 +72,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsAccounts.list({
+sdk.financialStatements.accounts.list({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   orderBy: "-modifiedDate",
   page: 1,

package/docs/sdks/financialstatementsbalancesheet/README.md

@@ -1,4 +1,4 @@
-# financialStatementsBalanceSheet
+# FinancialStatements.BalanceSheet
 
 ### Available Operations
 
@@ -21,7 +21,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsBalanceSheet.get({
+sdk.financialStatements.balanceSheet.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   periodLength: 4,
   periodsToCompare: 20,
@@ -65,7 +65,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsBalanceSheet.getCategorizedAccounts({
+sdk.financialStatements.balanceSheet.getCategorizedAccounts({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   numberOfPeriods: 568434,
   reportDate: "29-09-2020",

package/docs/sdks/financialstatementscashflow/README.md

@@ -1,4 +1,4 @@
-# financialStatementsCashFlow
+# FinancialStatements.CashFlow
 
 ### Available Operations
 
@@ -20,7 +20,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsCashFlow.get({
+sdk.financialStatements.cashFlow.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   periodLength: 4,
   periodsToCompare: 20,

package/docs/sdks/financialstatementsprofitandloss/README.md

@@ -1,4 +1,4 @@
-# financialStatementsProfitAndLoss
+# FinancialStatements.ProfitAndLoss
 
 ### Available Operations
 
@@ -21,7 +21,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsProfitAndLoss.get({
+sdk.financialStatements.profitAndLoss.get({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   periodLength: 4,
   periodsToCompare: 20,
@@ -65,7 +65,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.financialStatementsProfitAndLoss.getCategorizedAccounts({
+sdk.financialStatements.profitAndLoss.getCategorizedAccounts({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   numberOfPeriods: 324141,
   reportDate: "29-09-2020",

package/docs/sdks/liabilities/README.md

@@ -1,4 +1,4 @@
-# liabilities
+# Liabilities
 
 ## Overview
 

package/docs/sdks/loanwriteback/README.md

@@ -0,0 +1,4 @@
+# LoanWriteback
+
+### Available Operations
+

package/docs/sdks/loanwritebackaccounts/README.md

@@ -0,0 +1,134 @@
+# LoanWriteback.Accounts
+
+### Available Operations
+
+* [create](#create) - Create account
+* [getCreateModel](#getcreatemodel) - Get create account model
+
+## create
+
+The *Create account* endpoint creates a new [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.
+
+[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+
+**Integration-specific behaviour**
+
+Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { CreateAccountResponse } from "@codat/lending/dist/sdk/models/operations";
+import { AccountStatus, AccountType } from "@codat/lending/dist/sdk/models/shared";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.loanWriteback.accounts.create({
+  accountingAccount: {
+    currency: "USD",
+    currentBalance: 0,
+    description: "Invoices the business has issued but has not yet collected payment on.",
+    fullyQualifiedCategory: "Asset.Current",
+    fullyQualifiedName: "Cash On Hand",
+    id: "1b6266d1-1e44-46c5-8eb5-a8f98e03124e",
+    isBankAccount: false,
+    metadata: {
+      isDeleted: false,
+    },
+    modifiedDate: "2022-10-23T00:00:00.000Z",
+    name: "Accounts Receivable",
+    nominalCode: "610",
+    sourceModifiedDate: "2022-10-23T00:00:00.000Z",
+    status: AccountStatus.Active,
+    type: AccountType.Asset,
+    validDatatypeLinks: [
+      {
+        links: [
+          "natus",
+        ],
+        property: "laboriosam",
+      },
+    ],
+  },
+  allowSyncOnPushComplete: false,
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  forceUpdate: false,
+  timeoutInMinutes: 943749,
+}).then((res: CreateAccountResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `request`                                                                          | [operations.CreateAccountRequest](../../models/operations/createaccountrequest.md) | :heavy_check_mark:                                                                 | The request object to use for the request.                                         |
+| `retries`                                                                          | [utils.RetryConfig](../../models/utils/retryconfig.md)                             | :heavy_minus_sign:                                                                 | Configuration to override the default retry behavior of the client.                |
+| `config`                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                       | :heavy_minus_sign:                                                                 | Available config options for making requests.                                      |
+
+
+### Response
+
+**Promise<[operations.CreateAccountResponse](../../models/operations/createaccountresponse.md)>**
+
+
+## getCreateModel
+
+The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company and integration.
+
+[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+
+**Integration-specific behaviour**
+
+See the *response examples* for integration-specific indicative models.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCreateChartOfAccountsModelResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.loanWriteback.accounts.getCreateModel({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+}).then((res: GetCreateChartOfAccountsModelResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                          | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                          | [operations.GetCreateChartOfAccountsModelRequest](../../models/operations/getcreatechartofaccountsmodelrequest.md) | :heavy_check_mark:                                                                                                 | The request object to use for the request.                                                                         |
+| `retries`                                                                                                          | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                             | :heavy_minus_sign:                                                                                                 | Configuration to override the default retry behavior of the client.                                                |
+| `config`                                                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                       | :heavy_minus_sign:                                                                                                 | Available config options for making requests.                                                                      |
+
+
+### Response
+
+**Promise<[operations.GetCreateChartOfAccountsModelResponse](../../models/operations/getcreatechartofaccountsmodelresponse.md)>**
+