@codat/lending 3.2.0 → 4.0.0

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

@@ -5,7 +5,7 @@ import { BillStatus } from "./billstatus";
 import { Metadata } from "./metadata";
 import { SupplementalData } from "./supplementaldata";
 import { SupplierRef } from "./supplierref";
-export declare class AccountingBillPurchaseOrderReference extends SpeakeasyBase {
+export declare class PurchaseOrderReference extends SpeakeasyBase {
     /**
      * Identifier for the purchase order, unique for the company in the accounting platform.
      */
@@ -15,8 +15,14 @@ export declare class AccountingBillPurchaseOrderReference extends SpeakeasyBase
      */
     purchaseOrderNumber?: string;
 }
-export declare class AccountingBillWithholdingTax extends SpeakeasyBase {
+export declare class WithholdingTax 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 {
     /**
@@ -109,7 +115,7 @@ export declare class AccountingBill extends SpeakeasyBase {
      * An array of payment allocations.
      */
     paymentAllocations?: AccountingPaymentAllocation[];
-    purchaseOrderRefs?: AccountingBillPurchaseOrderReference[];
+    purchaseOrderRefs?: PurchaseOrderReference[];
     /**
      * User-friendly reference for the bill.
      */
@@ -143,5 +149,5 @@ export declare class AccountingBill extends SpeakeasyBase {
      * Amount of the bill, including tax.
      */
     totalAmount: number;
-    withholdingTax?: AccountingBillWithholdingTax[];
+    withholdingTax?: WithholdingTax[];
 }

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

@@ -27,7 +27,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AccountingBill = exports.AccountingBillWithholdingTax = exports.AccountingBillPurchaseOrderReference = void 0;
+exports.AccountingBill = exports.WithholdingTax = exports.PurchaseOrderReference = void 0;
 var utils_1 = require("../../../internal/utils");
 var accountingpaymentallocation_1 = require("./accountingpaymentallocation");
 var billlineitem_1 = require("./billlineitem");
@@ -36,42 +36,42 @@ var metadata_1 = require("./metadata");
 var supplementaldata_1 = require("./supplementaldata");
 var supplierref_1 = require("./supplierref");
 var class_transformer_1 = require("class-transformer");
-var AccountingBillPurchaseOrderReference = /** @class */ (function (_super) {
-    __extends(AccountingBillPurchaseOrderReference, _super);
-    function AccountingBillPurchaseOrderReference() {
+var PurchaseOrderReference = /** @class */ (function (_super) {
+    __extends(PurchaseOrderReference, _super);
+    function PurchaseOrderReference() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "id" }),
         __metadata("design:type", String)
-    ], AccountingBillPurchaseOrderReference.prototype, "id", void 0);
+    ], PurchaseOrderReference.prototype, "id", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "purchaseOrderNumber" }),
         __metadata("design:type", String)
-    ], AccountingBillPurchaseOrderReference.prototype, "purchaseOrderNumber", void 0);
-    return AccountingBillPurchaseOrderReference;
+    ], PurchaseOrderReference.prototype, "purchaseOrderNumber", void 0);
+    return PurchaseOrderReference;
 }(utils_1.SpeakeasyBase));
-exports.AccountingBillPurchaseOrderReference = AccountingBillPurchaseOrderReference;
-var AccountingBillWithholdingTax = /** @class */ (function (_super) {
-    __extends(AccountingBillWithholdingTax, _super);
-    function AccountingBillWithholdingTax() {
+exports.PurchaseOrderReference = PurchaseOrderReference;
+var WithholdingTax = /** @class */ (function (_super) {
+    __extends(WithholdingTax, _super);
+    function WithholdingTax() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "amount" }),
         __metadata("design:type", Number)
-    ], AccountingBillWithholdingTax.prototype, "amount", void 0);
+    ], WithholdingTax.prototype, "amount", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "name" }),
         __metadata("design:type", String)
-    ], AccountingBillWithholdingTax.prototype, "name", void 0);
-    return AccountingBillWithholdingTax;
+    ], WithholdingTax.prototype, "name", void 0);
+    return WithholdingTax;
 }(utils_1.SpeakeasyBase));
-exports.AccountingBillWithholdingTax = AccountingBillWithholdingTax;
+exports.WithholdingTax = WithholdingTax;
 /**
  * > **Invoices or bills?**
  *
@@ -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);
@@ -159,9 +159,9 @@ var AccountingBill = /** @class */ (function (_super) {
         __metadata("design:type", Array)
     ], AccountingBill.prototype, "paymentAllocations", void 0);
     __decorate([
-        (0, utils_1.SpeakeasyMetadata)({ elemType: AccountingBillPurchaseOrderReference }),
+        (0, utils_1.SpeakeasyMetadata)({ elemType: PurchaseOrderReference }),
         (0, class_transformer_1.Expose)({ name: "purchaseOrderRefs" }),
-        (0, class_transformer_1.Type)(function () { return AccountingBillPurchaseOrderReference; }),
+        (0, class_transformer_1.Type)(function () { return PurchaseOrderReference; }),
         __metadata("design:type", Array)
     ], AccountingBill.prototype, "purchaseOrderRefs", void 0);
     __decorate([
@@ -207,9 +207,9 @@ var AccountingBill = /** @class */ (function (_super) {
         __metadata("design:type", Number)
     ], AccountingBill.prototype, "totalAmount", void 0);
     __decorate([
-        (0, utils_1.SpeakeasyMetadata)({ elemType: AccountingBillWithholdingTax }),
+        (0, utils_1.SpeakeasyMetadata)({ elemType: WithholdingTax }),
         (0, class_transformer_1.Expose)({ name: "withholdingTax" }),
-        (0, class_transformer_1.Type)(function () { return AccountingBillWithholdingTax; }),
+        (0, class_transformer_1.Type)(function () { return WithholdingTax; }),
         __metadata("design:type", Array)
     ], AccountingBill.prototype, "withholdingTax", void 0);
     return AccountingBill;

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,9 +1,10 @@
 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>.
+ * > View the coverage for company profile 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>.
  *
  * @remarks
  *
@@ -11,7 +12,7 @@ import { WebLink } from "./weblink";
  *
  * > **Company information or companies?**
  * >
- * > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
+ * > Company profile is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
  */
 export declare class AccountingCompanyInfo extends SpeakeasyBase {
     /**
@@ -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.
      */

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

@@ -31,10 +31,11 @@ exports.AccountingCompanyInfo = void 0;
 var utils_1 = require("../../../internal/utils");
 var accountingaddress_1 = require("./accountingaddress");
 var phonenumber_1 = require("./phonenumber");
+var supplementaldata_1 = require("./supplementaldata");
 var weblink_1 = require("./weblink");
 var class_transformer_1 = require("class-transformer");
 /**
- * > 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>.
+ * > View the coverage for company profile 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>.
  *
  * @remarks
  *
@@ -42,7 +43,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * > **Company information or companies?**
  * >
- * > Company information is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
+ * > Company profile is standard information that is held in the accounting platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
  */
 var AccountingCompanyInfo = /** @class */ (function (_super) {
     __extends(AccountingCompanyInfo, _super);
@@ -106,6 +107,12 @@ var AccountingCompanyInfo = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "sourceUrls" }),
         __metadata("design:type", Object)
     ], AccountingCompanyInfo.prototype, "sourceUrls", 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)
+    ], AccountingCompanyInfo.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "taxNumber" }),

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

@@ -49,18 +49,18 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.
      *
      * The categories for an account include:
-     *   * Asset
-     *   * Expense
-     *   * Income
-     *   * Liability
-     *   * Equity.
+     * * Asset
+     * * Expense
+     * * Income
+     * * Liability
+     * * Equity.
      *
      * The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.
      *
      * 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**
@@ -78,6 +78,9 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * Available Data types
      */
     dataType?: DataType;
+    /**
+     * A message about the error.
+     */
     errorMessage?: string;
     /**
      * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
@@ -111,9 +114,17 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * The current status of the push operation.
      */
     status: PushOperationStatus;
+    /**
+     * Push status code.
+     */
     statusCode: number;
+    /**
+     * Number of minutes the push operation must complete within before it times out.
+     */
     timeoutInMinutes?: number;
     /**
+     * Number of seconds the push operation must complete within before it times out.
+     *
      * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     timeoutInSeconds?: number;