@codat/lending 3.2.0 → 3.3.0

package/dist/sdk/models/shared/{accountingcreatebankaccountresponse.js → accountingcreatepaymentresponse.js}

@@ -27,17 +27,17 @@ 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.AccountingCreateBankAccountResponse = void 0;
+exports.AccountingCreatePaymentResponse = void 0;
 var utils_1 = require("../../../internal/utils");
-var accountingbankaccount_1 = require("./accountingbankaccount");
+var accountingpayment_1 = require("./accountingpayment");
 var datatype_1 = require("./datatype");
 var pushoperationchange_1 = require("./pushoperationchange");
 var pushoperationstatus_1 = require("./pushoperationstatus");
 var validation_1 = require("./validation");
 var class_transformer_1 = require("class-transformer");
-var AccountingCreateBankAccountResponse = /** @class */ (function (_super) {
-    __extends(AccountingCreateBankAccountResponse, _super);
-    function AccountingCreateBankAccountResponse() {
+var AccountingCreatePaymentResponse = /** @class */ (function (_super) {
+    __extends(AccountingCreatePaymentResponse, _super);
+    function AccountingCreatePaymentResponse() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     __decorate([
@@ -45,74 +45,74 @@ var AccountingCreateBankAccountResponse = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "changes" }),
         (0, class_transformer_1.Type)(function () { return pushoperationchange_1.PushOperationChange; }),
         __metadata("design:type", Array)
-    ], AccountingCreateBankAccountResponse.prototype, "changes", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "changes", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "companyId" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "companyId", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "companyId", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "completedOnUtc" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "completedOnUtc", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "completedOnUtc", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "data" }),
-        (0, class_transformer_1.Type)(function () { return accountingbankaccount_1.AccountingBankAccount; }),
-        __metadata("design:type", accountingbankaccount_1.AccountingBankAccount)
-    ], AccountingCreateBankAccountResponse.prototype, "data", void 0);
+        (0, class_transformer_1.Type)(function () { return accountingpayment_1.AccountingPayment; }),
+        __metadata("design:type", accountingpayment_1.AccountingPayment)
+    ], AccountingCreatePaymentResponse.prototype, "data", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "dataConnectionKey" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "dataConnectionKey", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "dataConnectionKey", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "dataType" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "dataType", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "dataType", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "errorMessage" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "errorMessage", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "errorMessage", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "pushOperationKey" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "pushOperationKey", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "pushOperationKey", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "requestedOnUtc" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "requestedOnUtc", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "requestedOnUtc", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "status" }),
         __metadata("design:type", String)
-    ], AccountingCreateBankAccountResponse.prototype, "status", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "status", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "statusCode" }),
         __metadata("design:type", Number)
-    ], AccountingCreateBankAccountResponse.prototype, "statusCode", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "statusCode", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "timeoutInMinutes" }),
         __metadata("design:type", Number)
-    ], AccountingCreateBankAccountResponse.prototype, "timeoutInMinutes", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "timeoutInMinutes", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "timeoutInSeconds" }),
         __metadata("design:type", Number)
-    ], AccountingCreateBankAccountResponse.prototype, "timeoutInSeconds", void 0);
+    ], AccountingCreatePaymentResponse.prototype, "timeoutInSeconds", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "validation" }),
         (0, class_transformer_1.Type)(function () { return validation_1.Validation; }),
         __metadata("design:type", validation_1.Validation)
-    ], AccountingCreateBankAccountResponse.prototype, "validation", void 0);
-    return AccountingCreateBankAccountResponse;
+    ], AccountingCreatePaymentResponse.prototype, "validation", void 0);
+    return AccountingCreatePaymentResponse;
 }(utils_1.SpeakeasyBase));
-exports.AccountingCreateBankAccountResponse = AccountingCreateBankAccountResponse;
+exports.AccountingCreatePaymentResponse = AccountingCreatePaymentResponse;

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

@@ -44,7 +44,7 @@ export declare class AccountingCreateSupplierResponse extends SpeakeasyBase {
      *
      * ## Overview
      *
-     * From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill).
+     * From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill).
      */
     data?: AccountingSupplier;
     /**
@@ -55,6 +55,9 @@ export declare class AccountingCreateSupplierResponse 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.
@@ -88,9 +91,17 @@ export declare class AccountingCreateSupplierResponse 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;

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

@@ -42,7 +42,7 @@ export declare class AccountingCreateTransferResponse extends SpeakeasyBase {
      *
      * @remarks
      *
-     * A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+     * A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
      */
     data?: AccountingTransfer;
     /**
@@ -53,6 +53,9 @@ export declare class AccountingCreateTransferResponse 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.
@@ -86,9 +89,17 @@ export declare class AccountingCreateTransferResponse 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;

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

@@ -15,7 +15,7 @@ import { SupplementalData } from "./supplementaldata";
  *
  * Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.
  *
- * In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable.
+ * In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable.
  *
  * It contains details of:
  * * The amount of credit remaining and its status.
@@ -23,7 +23,13 @@ import { SupplementalData } from "./supplementaldata";
  * * Which customers the credit notes have been issued to.
  */
 export declare class AccountingCreditNote extends SpeakeasyBase {
+    /**
+     * Additional tax amount applied to credit note.
+     */
     additionalTaxAmount?: number;
+    /**
+     * Percentage rate of any additional tax applied to the credit note.
+     */
     additionalTaxPercentage?: 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:
@@ -144,6 +150,9 @@ export declare class AccountingCreditNote extends SpeakeasyBase {
      */
     remainingCredit: number;
     sourceModifiedDate?: string;
+    /**
+     * Current state of the credit note.
+     */
     status: CreditNoteStatus;
     /**
      * Value of the credit note, including discounts and excluding tax.

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

@@ -46,7 +46,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.
  *
- * In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable.
+ * In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable.
  *
  * It contains details of:
  * * The amount of credit remaining and its status.

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

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

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

@@ -13,7 +13,7 @@ import { SupplementalData } from "./supplementaldata";
  *
  * A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers).
  *
- * Customers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice).
+ * Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice).
  *
  */
 export declare class AccountingCustomer extends SpeakeasyBase {

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

@@ -44,7 +44,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers).
  *
- * Customers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice).
+ * Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice).
  *
  */
 var AccountingCustomer = /** @class */ (function (_super) {

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

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

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

@@ -21,7 +21,7 @@ import { SupplementalData } from "./supplementaldata";
  *   * Withdrawing money from a bank account
  *   * Writing a cheque
  *
- * Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  */
 export declare class AccountingDirectCost extends SpeakeasyBase {
     /**

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

@@ -52,7 +52,7 @@ var class_transformer_1 = require("class-transformer");
  *   * Withdrawing money from a bank account
  *   * Writing a cheque
  *
- * Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  */
 var AccountingDirectCost = /** @class */ (function (_super) {
     __extends(AccountingDirectCost, _super);

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

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

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

@@ -21,7 +21,7 @@ import { SupplementalData } from "./supplementaldata";
  * - Refunding an item in cash to a contact.
  * - Depositing money into a bank account.
  *
- * Direct incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  */
 export declare class AccountingDirectIncome extends SpeakeasyBase {
@@ -105,6 +105,9 @@ export declare class AccountingDirectIncome extends SpeakeasyBase {
     lineItems: DirectIncomeLineItem[];
     metadata?: Metadata;
     modifiedDate?: string;
+    /**
+     * An optional note on the direct income that can be used to assign the direct income with a reference ID in your application.
+     */
     note?: string;
     paymentAllocations: AccountingPaymentAllocation[];
     /**

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

@@ -52,7 +52,7 @@ var class_transformer_1 = require("class-transformer");
  * - Refunding an item in cash to a contact.
  * - Depositing money into a bank account.
  *
- * Direct incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  */
 var AccountingDirectIncome = /** @class */ (function (_super) {

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

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

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

@@ -1,13 +1,20 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountingCustomerRef } from "./accountingcustomerref";
 import { AccountingPaymentAllocation } from "./accountingpaymentallocation";
+import { DataType } from "./datatype";
 import { InvoiceLineItem } from "./invoicelineitem";
 import { InvoiceStatus } from "./invoicestatus";
 import { Items } from "./items";
 import { Metadata } from "./metadata";
 import { SupplementalData } from "./supplementaldata";
 export declare class AccountingInvoiceSalesOrderReference extends SpeakeasyBase {
-    dataType?: string;
+    /**
+     * Available Data types
+     */
+    dataType?: DataType;
+    /**
+     * Unique identifier to a record in `dataType`.
+     */
     id?: string;
 }
 /**
@@ -17,13 +24,13 @@ export declare class AccountingInvoiceSalesOrderReference extends SpeakeasyBase
  * >
  * > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.
  * >
- * > See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills.
+ * > See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills.
  *
  * View the coverage for invoices in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer).
+ * An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer).
  *
  * In Codat, an invoice contains details of:
  *
@@ -31,11 +38,11 @@ export declare class AccountingInvoiceSalesOrderReference extends SpeakeasyBase
  * - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in.
  * - Who the invoice has been raised to; the _customer_.
  * - The breakdown of what the invoice is for; the _line items_.
- * - Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.
+ * - Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.
  *
  * > **Invoice PDF downloads**
  * >
- * > You can <a className="external" href="https://docs.codat.io/accounting-api#/operations/get-invoice-pdf" target="_blank">download a PDF version</a> of an invoice for supported integrations.
+ * > You can <a className="external" href="https://docs.codat.io/lending-api#/operations/get-invoice-pdf" target="_blank">download a PDF version</a> of an invoice for supported integrations.
  * >
  * > The filename will be invoice-{number}.pdf.
  *
@@ -44,7 +51,13 @@ export declare class AccountingInvoiceSalesOrderReference extends SpeakeasyBase
  * > In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same.
  */
 export declare class AccountingInvoice extends SpeakeasyBase {
+    /**
+     * Additional tax amount applied to invoice.
+     */
     additionalTaxAmount?: number;
+    /**
+     * Percentage rate of any additional tax applied to the invoice.
+     */
     additionalTaxPercentage?: number;
     /**
      * Amount outstanding on the invoice.

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

@@ -31,6 +31,7 @@ exports.AccountingInvoice = exports.AccountingInvoiceSalesOrderReference = void
 var utils_1 = require("../../../internal/utils");
 var accountingcustomerref_1 = require("./accountingcustomerref");
 var accountingpaymentallocation_1 = require("./accountingpaymentallocation");
+var datatype_1 = require("./datatype");
 var invoicelineitem_1 = require("./invoicelineitem");
 var invoicestatus_1 = require("./invoicestatus");
 var items_1 = require("./items");
@@ -62,13 +63,13 @@ exports.AccountingInvoiceSalesOrderReference = AccountingInvoiceSalesOrderRefere
  * >
  * > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.
  * >
- * > See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills.
+ * > See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills.
  *
  * View the coverage for invoices in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer).
+ * An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer).
  *
  * In Codat, an invoice contains details of:
  *
@@ -76,11 +77,11 @@ exports.AccountingInvoiceSalesOrderReference = AccountingInvoiceSalesOrderRefere
  * - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in.
  * - Who the invoice has been raised to; the _customer_.
  * - The breakdown of what the invoice is for; the _line items_.
- * - Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.
+ * - Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.
  *
  * > **Invoice PDF downloads**
  * >
- * > You can <a className="external" href="https://docs.codat.io/accounting-api#/operations/get-invoice-pdf" target="_blank">download a PDF version</a> of an invoice for supported integrations.
+ * > You can <a className="external" href="https://docs.codat.io/lending-api#/operations/get-invoice-pdf" target="_blank">download a PDF version</a> of an invoice for supported integrations.
  * >
  * > The filename will be invoice-{number}.pdf.
  *

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

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

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

@@ -2,7 +2,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import { JournalStatus } from "./journalstatus";
 import { Metadata } from "./metadata";
 /**
- * > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type
+ * > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type
  *
  * @remarks
  *
@@ -10,7 +10,7 @@ import { Metadata } from "./metadata";
  *
  * ## Overview
  *
- * In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.
+ * In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.
  *
  * When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.
  *

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

@@ -33,7 +33,7 @@ var journalstatus_1 = require("./journalstatus");
 var metadata_1 = require("./metadata");
 var class_transformer_1 = require("class-transformer");
 /**
- * > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type
+ * > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type
  *
  * @remarks
  *
@@ -41,7 +41,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * ## Overview
  *
- * In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.
+ * In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.
  *
  * When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.
  *

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

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

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

@@ -5,7 +5,7 @@ import { Metadata } from "./metadata";
 import { RecordRef } from "./recordref";
 import { SupplementalData } from "./supplementaldata";
 /**
- * > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type
+ * > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type
  *
  * @remarks
  *
@@ -13,7 +13,7 @@ import { SupplementalData } from "./supplementaldata";
  *
  * ## Overview
  *
- * A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.
+ * A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.
  *
  * A journal entry line item is a single transaction line on the journal entry. For example:
  *

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

@@ -36,7 +36,7 @@ var recordref_1 = require("./recordref");
 var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
 /**
- * > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type
+ * > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type
  *
  * @remarks
  *
@@ -44,7 +44,7 @@ var class_transformer_1 = require("class-transformer");
  *
  * ## Overview
  *
- * A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.
+ * A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.
  *
  * A journal entry line item is a single transaction line on the journal entry. For example:
  *

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

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