@codat/lending 3.1.0 → 3.3.0

package/dist/sdk/models/shared/accountingaccount.js

@@ -32,6 +32,7 @@ var utils_1 = require("../../../internal/utils");
 var accountstatus_1 = require("./accountstatus");
 var accounttype_1 = require("./accounttype");
 var metadata_1 = require("./metadata");
+var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
 /**
  * When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
@@ -118,7 +119,7 @@ exports.AccountingAccountValidDataTypeLinks = AccountingAccountValidDataTypeLink
  * At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.
  *
  * To determine the list of allowed categories for a specific integration, you can:
- * - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).
+ * - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).
  * - Refer to the integration's own documentation.
  *
  * > **Accounts with no category**
@@ -198,6 +199,12 @@ var AccountingAccount = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "status" }),
         __metadata("design:type", String)
     ], AccountingAccount.prototype, "status", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "supplementalData" }),
+        (0, class_transformer_1.Type)(function () { return supplementaldata_1.SupplementalData; }),
+        __metadata("design:type", supplementaldata_1.SupplementalData)
+    ], AccountingAccount.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "type" }),

package/dist/sdk/models/shared/accountingaccounts.d.ts

@@ -3,8 +3,17 @@ import { AccountingAccount } from "./accountingaccount";
 import { Links } from "./links";
 export declare class AccountingAccounts extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingAccount[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingaccounttransaction.d.ts

@@ -12,7 +12,7 @@ export declare enum AccountingAccountTransactionStatus {
     Void = "Void"
 }
 /**
- * > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions).
+ * > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions).
  *
  * @remarks
  *
@@ -30,7 +30,7 @@ export declare enum AccountingAccountTransactionStatus {
  * * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.
  * * Transfers: for example, transferring money between two bank accounts.
  *
- * Account transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer).
+ * Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer).
  */
 export declare class AccountingAccountTransaction extends SpeakeasyBase {
     /**

package/dist/sdk/models/shared/accountingaccounttransaction.js

@@ -44,7 +44,7 @@ var AccountingAccountTransactionStatus;
     AccountingAccountTransactionStatus["Void"] = "Void";
 })(AccountingAccountTransactionStatus = exports.AccountingAccountTransactionStatus || (exports.AccountingAccountTransactionStatus = {}));
 /**
- * > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions).
+ * > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions).
  *
  * @remarks
  *
@@ -62,7 +62,7 @@ var AccountingAccountTransactionStatus;
  * * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.
  * * Transfers: for example, transferring money between two bank accounts.
  *
- * Account transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer).
+ * Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer).
  */
 var AccountingAccountTransaction = /** @class */ (function (_super) {
     __extends(AccountingAccountTransaction, _super);

package/dist/sdk/models/shared/accountingaccounttransactions.d.ts

@@ -3,8 +3,17 @@ import { AccountingAccountTransaction } from "./accountingaccounttransaction";
 import { Links } from "./links";
 export declare class AccountingAccountTransactions extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingAccountTransaction[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingagedcreditorreport.d.ts

@@ -13,7 +13,7 @@ import { AgedCreditor } from "./agedcreditor";
  *
  * ## Underlying data
  *
- * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment).
+ * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment).
  *
  * To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.
  *

package/dist/sdk/models/shared/accountingagedcreditorreport.js

@@ -44,7 +44,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * ## Underlying data
  *
- * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment).
+ * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment).
  *
  * To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.
  *

package/dist/sdk/models/shared/accountingageddebtorreport.d.ts

@@ -13,7 +13,7 @@ import { AgedDebtor } from "./ageddebtor";
  *
  * ## Underlying data
  *
- * The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).
+ * The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment).
  *
  * To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.
  *

package/dist/sdk/models/shared/accountingageddebtorreport.js

@@ -44,7 +44,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * ## Underlying data
  *
- * The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).
+ * The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment).
  *
  * To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.
  *

package/dist/sdk/models/shared/accountingattachment.d.ts

@@ -8,7 +8,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
  * >
  * > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.
  *
- * Unlike other data types, Codat doesn't support sync settings for attachments.
+ * Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.
  *
  * Note that different integrations have different requirements to file size and extension of attachments.
  *

package/dist/sdk/models/shared/accountingattachment.js

@@ -39,7 +39,7 @@ var class_transformer_1 = require("class-transformer");
  * >
  * > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.
  *
- * Unlike other data types, Codat doesn't support sync settings for attachments.
+ * Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.
  *
  * Note that different integrations have different requirements to file size and extension of attachments.
  *

package/dist/sdk/models/shared/accountingbankaccount.d.ts

@@ -1,6 +1,7 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountingBankAccountType } from "./accountingbankaccounttype";
 import { Metadata } from "./metadata";
+import { SupplementalData } from "./supplementaldata";
 /**
  * > **Accessing Bank Accounts through Banking API**
  *
@@ -8,7 +9,7 @@ import { Metadata } from "./metadata";
  * >
  * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
  * >
- * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)
+ * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/schemas/Account)
  *
  * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>.
  *
@@ -102,4 +103,12 @@ export declare class AccountingBankAccount extends SpeakeasyBase {
      */
     sortCode?: string;
     sourceModifiedDate?: string;
+    /**
+     * Supplemental data is additional data you can include in our standard data types.
+     *
+     * @remarks
+     *
+     * It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.
+     */
+    supplementalData?: SupplementalData;
 }

package/dist/sdk/models/shared/accountingbankaccount.js

@@ -31,6 +31,7 @@ exports.AccountingBankAccount = void 0;
 var utils_1 = require("../../../internal/utils");
 var accountingbankaccounttype_1 = require("./accountingbankaccounttype");
 var metadata_1 = require("./metadata");
+var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
 /**
  * > **Accessing Bank Accounts through Banking API**
@@ -39,7 +40,7 @@ var class_transformer_1 = require("class-transformer");
  * >
  * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
  * >
- * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)
+ * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/schemas/Account)
  *
  * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>.
  *
@@ -133,6 +134,12 @@ var AccountingBankAccount = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "sourceModifiedDate" }),
         __metadata("design:type", String)
     ], AccountingBankAccount.prototype, "sourceModifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "supplementalData" }),
+        (0, class_transformer_1.Type)(function () { return supplementaldata_1.SupplementalData; }),
+        __metadata("design:type", supplementaldata_1.SupplementalData)
+    ], AccountingBankAccount.prototype, "supplementalData", void 0);
     return AccountingBankAccount;
 }(utils_1.SpeakeasyBase));
 exports.AccountingBankAccount = AccountingBankAccount;

package/dist/sdk/models/shared/accountingbankaccounts.d.ts

@@ -3,8 +3,17 @@ import { AccountingBankAccount } from "./accountingbankaccount";
 import { Links } from "./links";
 export declare class AccountingBankAccounts extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBankAccount[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingbanktransaction.d.ts

@@ -7,7 +7,7 @@ import { BankTransactionType } from "./banktransactiontype";
  * >
  * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
  * >
- * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions)
+ * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions)
  *
  * > View the coverage for bank transactions in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions" target="_blank">Data coverage explorer</a>.
  *
@@ -21,8 +21,17 @@ import { BankTransactionType } from "./banktransactiontype";
  * * Transaction type, for example, credit, debit, or transfer.
  */
 export declare class AccountingBankTransaction extends SpeakeasyBase {
+    /**
+     * Unique identifier to the `accountId` the bank transactions originates from.
+     */
     accountId?: string;
+    /**
+     * The amount transacted in the bank transaction.
+     */
     amount?: number;
+    /**
+     * The remaining balance in the account with ID `accountId`.
+     */
     balance?: number;
     /**
      * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
@@ -48,13 +57,22 @@ export declare class AccountingBankTransaction extends SpeakeasyBase {
      * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
     clearedOnDate?: string;
+    /**
+     * Description of the bank transaction.
+     */
     description?: string;
+    /**
+     * Identifier for the bank transaction, unique to the company in the accounting platform.
+     */
     id?: string;
     modifiedDate?: string;
+    /**
+     * `True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting platform.
+     */
     reconciled?: boolean;
     sourceModifiedDate?: string;
     /**
-     * Type of transaction for the bank statement line
+     * Type of transaction for the bank statement line.
      */
     transactionType?: BankTransactionType;
 }

package/dist/sdk/models/shared/accountingbanktransaction.js

@@ -38,7 +38,7 @@ var class_transformer_1 = require("class-transformer");
  * >
  * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
  * >
- * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions)
+ * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions)
  *
  * > View the coverage for bank transactions in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions" target="_blank">Data coverage explorer</a>.
  *

package/dist/sdk/models/shared/accountingbanktransactions.d.ts

@@ -3,8 +3,17 @@ import { AccountingBankTransaction } from "./accountingbanktransaction";
 import { Links } from "./links";
 export declare class AccountingBankTransactions extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBankTransaction[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingbill.d.ts

@@ -16,7 +16,13 @@ export declare class AccountingBillPurchaseOrderReference extends SpeakeasyBase
     purchaseOrderNumber?: string;
 }
 export declare class AccountingBillWithholdingTax extends SpeakeasyBase {
+    /**
+     * Amount of tax withheld.
+     */
     amount: number;
+    /**
+     * Name assigned to withheld tax.
+     */
     name: string;
 }
 /**
@@ -26,7 +32,7 @@ export declare class AccountingBillWithholdingTax extends SpeakeasyBase {
  * >
  * > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill.
  * >
- * > See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills.
+ * > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills.
  *
  * View the coverage for bills in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills" target="_blank">Data coverage explorer</a>.
  *
@@ -40,7 +46,7 @@ export declare class AccountingBillWithholdingTax extends SpeakeasyBase {
  *
  * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*.
  *
- * You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  */
 export declare class AccountingBill extends SpeakeasyBase {
     /**

package/dist/sdk/models/shared/accountingbill.js

@@ -79,7 +79,7 @@ exports.AccountingBillWithholdingTax = AccountingBillWithholdingTax;
  * >
  * > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill.
  * >
- * > See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills.
+ * > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills.
  *
  * View the coverage for bills in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills" target="_blank">Data coverage explorer</a>.
  *
@@ -93,7 +93,7 @@ exports.AccountingBillWithholdingTax = AccountingBillWithholdingTax;
  *
  * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*.
  *
- * You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  */
 var AccountingBill = /** @class */ (function (_super) {
     __extends(AccountingBill, _super);

package/dist/sdk/models/shared/accountingbillcreditnote.d.ts

@@ -11,7 +11,7 @@ import { SupplierRef } from "./supplierref";
  *
  * @remarks
  * >
- * > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * View the coverage for bill credit notes in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes" target="_blank">Data coverage explorer</a>.
  *
@@ -19,11 +19,11 @@ import { SupplierRef } from "./supplierref";
  *
  * A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.
  *
- * In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier).
+ * In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier).
  *
  * A bill credit note includes details of:
  * * The original and remaining credit.
- * * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/accounting-api#/schemas/Bill).
+ * * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill).
  * * The supplier that issued the bill credit note.
  */
 export declare class AccountingBillCreditNote extends SpeakeasyBase {

package/dist/sdk/models/shared/accountingbillcreditnote.js

@@ -42,7 +42,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * @remarks
  * >
- * > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * View the coverage for bill credit notes in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes" target="_blank">Data coverage explorer</a>.
  *
@@ -50,11 +50,11 @@ var class_transformer_1 = require("class-transformer");
  *
  * A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.
  *
- * In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier).
+ * In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier).
  *
  * A bill credit note includes details of:
  * * The original and remaining credit.
- * * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/accounting-api#/schemas/Bill).
+ * * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill).
  * * The supplier that issued the bill credit note.
  */
 var AccountingBillCreditNote = /** @class */ (function (_super) {

package/dist/sdk/models/shared/accountingbillcreditnotes.d.ts

@@ -3,8 +3,17 @@ import { AccountingBillCreditNote } from "./accountingbillcreditnote";
 import { Links } from "./links";
 export declare class AccountingBillCreditNotes extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBillCreditNote[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingbillpayment.d.ts

@@ -2,6 +2,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountRef } from "./accountref";
 import { BillPaymentLine } from "./billpaymentline";
 import { Metadata } from "./metadata";
+import { PaymentMethodRef } from "./paymentmethodref";
 import { SupplementalData } from "./supplementaldata";
 import { SupplierRef } from "./supplierref";
 /**
@@ -11,13 +12,13 @@ import { SupplierRef } from "./supplierref";
  * >
  * > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.
  * >
- * > See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * > View the coverage for bill payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)).
+ * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).
  *
  * A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:
  *
@@ -34,9 +35,9 @@ import { SupplierRef } from "./supplierref";
  * - Who the payment has been paid to, the _supplier_.
  * - The types of bill payments, the _line items_.
  *
- * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  *
- * Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  * ---
  *
@@ -210,7 +211,7 @@ export declare class AccountingBillPayment extends SpeakeasyBase {
      * Additional information associated with the payment.
      */
     note?: string;
-    paymentMethodRef?: any;
+    paymentMethodRef?: PaymentMethodRef;
     /**
      * Additional information associated with the payment.
      */

package/dist/sdk/models/shared/accountingbillpayment.js

@@ -32,6 +32,7 @@ var utils_1 = require("../../../internal/utils");
 var accountref_1 = require("./accountref");
 var billpaymentline_1 = require("./billpaymentline");
 var metadata_1 = require("./metadata");
+var paymentmethodref_1 = require("./paymentmethodref");
 var supplementaldata_1 = require("./supplementaldata");
 var supplierref_1 = require("./supplierref");
 var class_transformer_1 = require("class-transformer");
@@ -42,13 +43,13 @@ var class_transformer_1 = require("class-transformer");
  * >
  * > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.
  * >
- * > See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * > View the coverage for bill payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)).
+ * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).
  *
  * A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:
  *
@@ -65,9 +66,9 @@ var class_transformer_1 = require("class-transformer");
  * - Who the payment has been paid to, the _supplier_.
  * - The types of bill payments, the _line items_.
  *
- * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  *
- * Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  * ---
  *
@@ -246,7 +247,8 @@ var AccountingBillPayment = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "paymentMethodRef" }),
-        __metadata("design:type", Object)
+        (0, class_transformer_1.Type)(function () { return paymentmethodref_1.PaymentMethodRef; }),
+        __metadata("design:type", paymentmethodref_1.PaymentMethodRef)
     ], AccountingBillPayment.prototype, "paymentMethodRef", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),

package/dist/sdk/models/shared/accountingbillpayments.d.ts

@@ -3,8 +3,17 @@ import { AccountingBillPayment } from "./accountingbillpayment";
 import { Links } from "./links";
 export declare class AccountingBillPayments extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBillPayment[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingbills.d.ts

@@ -3,8 +3,17 @@ import { AccountingBill } from "./accountingbill";
 import { Links } from "./links";
 export declare class AccountingBills extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBill[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

package/dist/sdk/models/shared/accountingcompanyinfo.d.ts

@@ -1,6 +1,7 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountingAddress } from "./accountingaddress";
 import { PhoneNumber } from "./phonenumber";
+import { SupplementalData } from "./supplementaldata";
 import { WebLink } from "./weblink";
 /**
  * > View the coverage for company info in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=cashFlowStatement" target="_blank">Data coverage explorer</a>.
@@ -122,6 +123,14 @@ export declare class AccountingCompanyInfo extends SpeakeasyBase {
      * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero).
      */
     sourceUrls?: Record<string, string>;
+    /**
+     * Supplemental data is additional data you can include in our standard data types.
+     *
+     * @remarks
+     *
+     * It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.
+     */
+    supplementalData?: SupplementalData;
     /**
      * Company tax number.
      */