npm - @codat/lending - Versions diffs - 6.0.0 → 7.1.0 - Mend

@codat/lending 6.0.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (786) hide show

package/src/funcs/accountsPayableBillPaymentsList.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function accountsPayableBillPaymentsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsPayableBillsDownloadAttachment.ts CHANGED Viewed

@@ -119,6 +119,7 @@ export async function accountsPayableBillsDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableBillsGet.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function accountsPayableBillsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableBillsGetAttachment.ts CHANGED Viewed

@@ -117,6 +117,7 @@ export async function accountsPayableBillsGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableBillsList.ts CHANGED Viewed

@@ -116,6 +116,7 @@ export async function accountsPayableBillsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsPayableBillsListAttachments.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsPayableBillsListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableSuppliersDownloadAttachment.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function accountsPayableSuppliersDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableSuppliersGet.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsPayableSuppliersGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableSuppliersGetAttachment.ts CHANGED Viewed

@@ -119,6 +119,7 @@ export async function accountsPayableSuppliersGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsPayableSuppliersList.ts CHANGED Viewed

@@ -112,6 +112,7 @@ export async function accountsPayableSuppliersList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsPayableSuppliersListAttachments.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsPayableSuppliersListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableCreditNotesGet.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsReceivableCreditNotesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableCreditNotesList.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function accountsReceivableCreditNotesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableCustomersDownloadAttachment.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function accountsReceivableCustomersDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableCustomersGet.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsReceivableCustomersGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableCustomersGetAttachment.ts CHANGED Viewed

@@ -119,6 +119,7 @@ export async function accountsReceivableCustomersGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableCustomersList.ts CHANGED Viewed

@@ -112,6 +112,7 @@ export async function accountsReceivableCustomersList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableCustomersListAttachments.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsReceivableCustomersListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableDirectIncomesDownloadAttachment.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function accountsReceivableDirectIncomesDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableDirectIncomesGet.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsReceivableDirectIncomesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableDirectIncomesGetAttachment.ts CHANGED Viewed

@@ -122,6 +122,7 @@ export async function accountsReceivableDirectIncomesGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableDirectIncomesList.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function accountsReceivableDirectIncomesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableDirectIncomesListAttachments.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function accountsReceivableDirectIncomesListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesDownloadAttachment.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function accountsReceivableInvoicesDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesDownloadPdf.ts CHANGED Viewed

@@ -109,6 +109,7 @@ export async function accountsReceivableInvoicesDownloadPdf(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesGet.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsReceivableInvoicesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesGetAttachment.ts CHANGED Viewed

@@ -119,6 +119,7 @@ export async function accountsReceivableInvoicesGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesList.ts CHANGED Viewed

@@ -123,6 +123,7 @@ export async function accountsReceivableInvoicesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableInvoicesListAttachments.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function accountsReceivableInvoicesListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableInvoicesListReconciled.ts CHANGED Viewed

@@ -109,6 +109,7 @@ export async function accountsReceivableInvoicesListReconciled(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivablePaymentsGet.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsReceivablePaymentsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivablePaymentsList.ts CHANGED Viewed

@@ -112,6 +112,7 @@ export async function accountsReceivablePaymentsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableReportsGetAgedCreditors.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsReceivableReportsGetAgedCreditors(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableReportsGetAgedDebtors.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function accountsReceivableReportsGetAgedDebtors(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/accountsReceivableReportsIsAgedCreditorsAvailable.ts CHANGED Viewed

@@ -105,6 +105,7 @@ export async function accountsReceivableReportsIsAgedCreditorsAvailable(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/accountsReceivableReportsIsAgedDebtorsAvailable.ts CHANGED Viewed

@@ -105,6 +105,7 @@ export async function accountsReceivableReportsIsAgedDebtorsAvailable(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankStatementsEndUploadSession.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankStatementsEndUploadSession(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankStatementsGetUploadConfiguration.ts CHANGED Viewed

@@ -112,6 +112,7 @@ export async function bankStatementsGetUploadConfiguration(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankStatementsSetUploadConfiguration.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function bankStatementsSetUploadConfiguration(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankStatementsStartUploadSession.ts CHANGED Viewed

@@ -116,6 +116,7 @@ export async function bankStatementsStartUploadSession(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankStatementsUploadBankStatementData.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankStatementsUploadBankStatementData(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/bankingAccountBalancesList.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankingAccountBalancesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/bankingAccountsGet.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function bankingAccountsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankingAccountsList.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankingAccountsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/bankingCategorizedStatementGet.ts CHANGED Viewed

@@ -113,6 +113,7 @@ export async function bankingCategorizedStatementGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/bankingTransactionCategoriesGet.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankingTransactionCategoriesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankingTransactionCategoriesList.ts CHANGED Viewed

@@ -120,6 +120,7 @@ export async function bankingTransactionCategoriesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/bankingTransactionsGet.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function bankingTransactionsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/bankingTransactionsList.ts CHANGED Viewed

@@ -118,6 +118,7 @@ export async function bankingTransactionsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/companiesCreate.ts CHANGED Viewed

@@ -100,6 +100,7 @@ export async function companiesCreate(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companiesDelete.ts CHANGED Viewed

@@ -103,6 +103,7 @@ export async function companiesDelete(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "DELETE",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companiesGet.ts CHANGED Viewed

@@ -103,6 +103,7 @@ export async function companiesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companiesList.ts CHANGED Viewed

@@ -31,6 +31,19 @@ import { Result } from "../sdk/types/fp.js";
  *
  * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
  * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ *
+ * ## Filter by tags
+ *
+ * The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
+ *
+ * - equals (`=`)
+ * - not equals (`!=`)
+ * - contains (`~`)
+ *
+ * For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+ * - Foreign key: `uid = {yourCustomerId}`
+ * - Region: `region != uk`
+ * - Owning team and region: `region = uk && owningTeam = invoice-finance`
  */
 export async function companiesList(
   client: CodatLendingCore,
@@ -68,6 +81,7 @@ export async function companiesList(
     "page": payload?.page,
     "pageSize": payload?.pageSize,
     "query": payload?.query,
+    "tags": payload?.tags,
   });
   const headers = new Headers({
@@ -104,6 +118,7 @@ export async function companiesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/companiesUpdate.ts CHANGED Viewed

@@ -106,6 +106,7 @@ export async function companiesUpdate(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "PUT",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companyInfoGetAccountingProfile.ts CHANGED Viewed

@@ -101,6 +101,7 @@ export async function companyInfoGetAccountingProfile(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companyInfoGetCommerceProfile.ts CHANGED Viewed

@@ -110,6 +110,7 @@ export async function companyInfoGetCommerceProfile(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/connectionsCreate.ts CHANGED Viewed

@@ -103,6 +103,7 @@ export async function connectionsCreate(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/connectionsDelete.ts CHANGED Viewed

@@ -107,6 +107,7 @@ export async function connectionsDelete(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "DELETE",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/connectionsGet.ts CHANGED Viewed

@@ -106,6 +106,7 @@ export async function connectionsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/connectionsList.ts CHANGED Viewed

@@ -107,6 +107,7 @@ export async function connectionsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/connectionsUnlink.ts CHANGED Viewed

@@ -107,6 +107,7 @@ export async function connectionsUnlink(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "PATCH",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/dataIntegrityDetails.ts CHANGED Viewed

@@ -116,6 +116,7 @@ export async function dataIntegrityDetails(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/dataIntegrityStatus.ts CHANGED Viewed

@@ -114,6 +114,7 @@ export async function dataIntegrityStatus(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/dataIntegritySummaries.ts CHANGED Viewed

@@ -115,6 +115,7 @@ export async function dataIntegritySummaries(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/excelReportsDownload.ts CHANGED Viewed

@@ -111,6 +111,7 @@ export async function excelReportsDownload(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/excelReportsGenerate.ts CHANGED Viewed

@@ -120,6 +120,7 @@ export async function excelReportsGenerate(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "POST",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,