@codat/lending 3.1.0 → 3.3.0

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

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

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

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

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

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

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

@@ -22,5 +22,8 @@ export declare class BankingTransactionCategory extends SpeakeasyBase {
      */
     parentId?: string;
     sourceModifiedDate?: string;
+    /**
+     * The status of the transaction category.
+     */
     status?: TransactionCategoryStatus;
 }

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

@@ -1,8 +1,20 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class BankingTransactionRef extends SpeakeasyBase {
+    /**
+     * Unique identifier of the bank transaction's account.
+     */
     accountId?: string;
+    /**
+     * Name given to account.
+     */
     accountName?: string;
+    /**
+     * Bank transaction amount.
+     */
     amount?: number;
+    /**
+     * Unique identifier of the bank transaction's connection.
+     */
     dataConnectionId?: string;
     /**
      * 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:
@@ -28,6 +40,12 @@ export declare class BankingTransactionRef 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.
      */
     date?: string;
+    /**
+     * Description given to bank transaction.
+     */
     description?: string;
+    /**
+     * Unique identifier for the bank transaction.
+     */
     id?: string;
 }

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

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

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

@@ -1,5 +1,5 @@
 /**
- * Type of transaction for the bank statement line
+ * Type of transaction for the bank statement line.
  */
 export declare enum BankTransactionType {
     Unknown = "Unknown",

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

@@ -5,7 +5,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BankTransactionType = void 0;
 /**
- * Type of transaction for the bank statement line
+ * Type of transaction for the bank statement line.
  */
 var BankTransactionType;
 (function (BankTransactionType) {

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

@@ -1,3 +1,6 @@
+/**
+ * Defines if the invoice or credit note is billed/rebilled to a project or customer.
+ */
 export declare enum BilledToType {
     Unknown = "Unknown",
     NotApplicable = "NotApplicable",

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

@@ -4,6 +4,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BilledToType = void 0;
+/**
+ * Defines if the invoice or credit note is billed/rebilled to a project or customer.
+ */
 var BilledToType;
 (function (BilledToType) {
     BilledToType["Unknown"] = "Unknown";

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

@@ -1,3 +1,6 @@
+/**
+ * Defines if the bill or bill credit note is billed/rebilled to a project.
+ */
 export declare enum BilledToType1 {
     Unknown = "Unknown",
     NotApplicable = "NotApplicable",

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

@@ -4,6 +4,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BilledToType1 = void 0;
+/**
+ * Defines if the bill or bill credit note is billed/rebilled to a project.
+ */
 var BilledToType1;
 (function (BilledToType1) {
     BilledToType1["Unknown"] = "Unknown";

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

@@ -4,6 +4,29 @@ import { AccountsPayableTracking } from "./accountspayabletracking";
 import { ItemRef } from "./itemref";
 import { TaxRateRef } from "./taxrateref";
 import { TrackingCategoryRef } from "./trackingcategoryref";
+/**
+ * Allowed name of the 'dataType'.
+ */
+export declare enum BillLineItemRecordLineReferenceDataType {
+    PurchaseOrders = "purchaseOrders"
+}
+/**
+ * Reference to the purchase order line this line was generated from.
+ */
+export declare class BillLineItemRecordLineReference extends SpeakeasyBase {
+    /**
+     * Allowed name of the 'dataType'.
+     */
+    dataType?: BillLineItemRecordLineReferenceDataType;
+    /**
+     * 'id' of the underlying record.
+     */
+    id?: string;
+    /**
+     * Line number of the underlying record.
+     */
+    lineNumber?: string;
+}
 export declare class BillLineItem extends SpeakeasyBase {
     /**
      * Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.
@@ -21,12 +44,26 @@ export declare class BillLineItem extends SpeakeasyBase {
      * Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference.
      */
     discountAmount?: number;
+    /**
+     * Percentage rate of any discount applied to the bill.
+     */
     discountPercentage?: number;
+    /**
+     * The bill is a direct cost if `True`.
+     */
     isDirectCost?: boolean;
     /**
      * Reference to the item the line is linked to.
      */
     itemRef?: ItemRef;
+    /**
+     * The bill line's number.
+     */
+    lineNumber?: string;
+    /**
+     * Reference to the purchase order line this line was generated from.
+     */
+    purchaseOrderLineRef?: BillLineItemRecordLineReference;
     /**
      * Number of units of goods or services received.
      */

package/dist/sdk/models/shared/billlineitem.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.BillLineItem = void 0;
+exports.BillLineItem = exports.BillLineItemRecordLineReference = exports.BillLineItemRecordLineReferenceDataType = void 0;
 var utils_1 = require("../../../internal/utils");
 var accountref_1 = require("./accountref");
 var accountspayabletracking_1 = require("./accountspayabletracking");
@@ -35,6 +35,39 @@ var itemref_1 = require("./itemref");
 var taxrateref_1 = require("./taxrateref");
 var trackingcategoryref_1 = require("./trackingcategoryref");
 var class_transformer_1 = require("class-transformer");
+/**
+ * Allowed name of the 'dataType'.
+ */
+var BillLineItemRecordLineReferenceDataType;
+(function (BillLineItemRecordLineReferenceDataType) {
+    BillLineItemRecordLineReferenceDataType["PurchaseOrders"] = "purchaseOrders";
+})(BillLineItemRecordLineReferenceDataType = exports.BillLineItemRecordLineReferenceDataType || (exports.BillLineItemRecordLineReferenceDataType = {}));
+/**
+ * Reference to the purchase order line this line was generated from.
+ */
+var BillLineItemRecordLineReference = /** @class */ (function (_super) {
+    __extends(BillLineItemRecordLineReference, _super);
+    function BillLineItemRecordLineReference() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataType" }),
+        __metadata("design:type", String)
+    ], BillLineItemRecordLineReference.prototype, "dataType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], BillLineItemRecordLineReference.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "lineNumber" }),
+        __metadata("design:type", String)
+    ], BillLineItemRecordLineReference.prototype, "lineNumber", void 0);
+    return BillLineItemRecordLineReference;
+}(utils_1.SpeakeasyBase));
+exports.BillLineItemRecordLineReference = BillLineItemRecordLineReference;
 var BillLineItem = /** @class */ (function (_super) {
     __extends(BillLineItem, _super);
     function BillLineItem() {
@@ -72,6 +105,17 @@ var BillLineItem = /** @class */ (function (_super) {
         (0, class_transformer_1.Type)(function () { return itemref_1.ItemRef; }),
         __metadata("design:type", itemref_1.ItemRef)
     ], BillLineItem.prototype, "itemRef", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "lineNumber" }),
+        __metadata("design:type", String)
+    ], BillLineItem.prototype, "lineNumber", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "purchaseOrderLineRef" }),
+        (0, class_transformer_1.Type)(function () { return BillLineItemRecordLineReference; }),
+        __metadata("design:type", BillLineItemRecordLineReference)
+    ], BillLineItem.prototype, "purchaseOrderLineRef", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "quantity" }),

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

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

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

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

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

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

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

@@ -4,16 +4,7 @@ import { LocationRef } from "./locationref";
 import { OrderLineItem } from "./orderlineitem";
 import { PaymentRef } from "./paymentref";
 import { ServiceCharge } from "./servicecharge";
-/**
- * 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.
- */
-export declare class CommerceOrderSupplementalData extends SpeakeasyBase {
-    content?: Record<string, Record<string, any>>;
-}
+import { SupplementalData } from "./supplementaldata";
 /**
  * Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR).
  *
@@ -110,21 +101,21 @@ export declare class CommerceOrder extends SpeakeasyBase {
      *
      * 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?: CommerceOrderSupplementalData;
+    supplementalData?: SupplementalData;
     /**
-     * Total amount of the order, including tax, net of any discounts and refunds.
+     * Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.
      */
     totalAmount?: number;
     /**
-     * Total amount of discount applied to the order.
+     * Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).
      */
     totalDiscount?: number;
     /**
-     * Extra amount added to a bill.
+     * Extra amount added to the order.
      */
     totalGratuity?: number;
     /**
-     * Total amount refunded issued by a merchant on an order (always a negative value).
+     * Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.
      */
     totalRefund?: number;
     /**

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

@@ -27,34 +27,15 @@ 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.CommerceOrder = exports.CommerceOrderSupplementalData = void 0;
+exports.CommerceOrder = void 0;
 var utils_1 = require("../../../internal/utils");
 var commercecustomerref_1 = require("./commercecustomerref");
 var locationref_1 = require("./locationref");
 var orderlineitem_1 = require("./orderlineitem");
 var paymentref_1 = require("./paymentref");
 var servicecharge_1 = require("./servicecharge");
+var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
-/**
- * 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.
- */
-var CommerceOrderSupplementalData = /** @class */ (function (_super) {
-    __extends(CommerceOrderSupplementalData, _super);
-    function CommerceOrderSupplementalData() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "content" }),
-        __metadata("design:type", Object)
-    ], CommerceOrderSupplementalData.prototype, "content", void 0);
-    return CommerceOrderSupplementalData;
-}(utils_1.SpeakeasyBase));
-exports.CommerceOrderSupplementalData = CommerceOrderSupplementalData;
 /**
  * Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR).
  *
@@ -141,8 +122,8 @@ var CommerceOrder = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "supplementalData" }),
-        (0, class_transformer_1.Type)(function () { return CommerceOrderSupplementalData; }),
-        __metadata("design:type", CommerceOrderSupplementalData)
+        (0, class_transformer_1.Type)(function () { return supplementaldata_1.SupplementalData; }),
+        __metadata("design:type", supplementaldata_1.SupplementalData)
     ], CommerceOrder.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),

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

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

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

@@ -1,5 +1,7 @@
 import { SpeakeasyBase } from "../../../internal/utils";
+import { PaymentMethodRef } from "./paymentmethodref";
 import { PaymentStatus } from "./paymentstatus";
+import { SupplementalData } from "./supplementaldata";
 /**
  * Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.
  *
@@ -81,7 +83,10 @@ export declare class CommercePayment extends SpeakeasyBase {
      */
     id: string;
     modifiedDate?: string;
-    paymentMethodRef?: any;
+    /**
+     * The payment method the record is linked to in the accounting or commerce platform.
+     */
+    paymentMethodRef?: PaymentMethodRef;
     /**
      * Service provider of the payment, if applicable.
      */
@@ -91,4 +96,12 @@ export declare class CommercePayment extends SpeakeasyBase {
      * Status of the payment.
      */
     status?: PaymentStatus;
+    /**
+     * 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/commercepayment.js

@@ -29,7 +29,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommercePayment = void 0;
 var utils_1 = require("../../../internal/utils");
+var paymentmethodref_1 = require("./paymentmethodref");
 var paymentstatus_1 = require("./paymentstatus");
+var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
 /**
  * Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.
@@ -80,7 +82,8 @@ var CommercePayment = /** @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)
     ], CommercePayment.prototype, "paymentMethodRef", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
@@ -97,6 +100,12 @@ var CommercePayment = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "status" }),
         __metadata("design:type", String)
     ], CommercePayment.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)
+    ], CommercePayment.prototype, "supplementalData", void 0);
     return CommercePayment;
 }(utils_1.SpeakeasyBase));
 exports.CommercePayment = CommercePayment;

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

@@ -1,5 +1,12 @@
 import { SpeakeasyBase } from "../../../internal/utils";
-import { PaymentMethodStatus } from "./paymentmethodstatus";
+/**
+ * Status of the Payment Method.
+ */
+export declare enum CommercePaymentMethodStatus {
+    Unknown = "Unknown",
+    Active = "Active",
+    Archived = "Archived"
+}
 /**
  * A Payment Method represents the payment method(s) used to make payments.
  *
@@ -19,7 +26,7 @@ export declare class CommercePaymentMethod extends SpeakeasyBase {
     name?: string;
     sourceModifiedDate?: string;
     /**
-     * Status of the Payment Method
+     * Status of the Payment Method.
      */
-    status?: PaymentMethodStatus;
+    status?: CommercePaymentMethodStatus;
 }

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

@@ -27,10 +27,18 @@ 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.CommercePaymentMethod = void 0;
+exports.CommercePaymentMethod = exports.CommercePaymentMethodStatus = void 0;
 var utils_1 = require("../../../internal/utils");
-var paymentmethodstatus_1 = require("./paymentmethodstatus");
 var class_transformer_1 = require("class-transformer");
+/**
+ * Status of the Payment Method.
+ */
+var CommercePaymentMethodStatus;
+(function (CommercePaymentMethodStatus) {
+    CommercePaymentMethodStatus["Unknown"] = "Unknown";
+    CommercePaymentMethodStatus["Active"] = "Active";
+    CommercePaymentMethodStatus["Archived"] = "Archived";
+})(CommercePaymentMethodStatus = exports.CommercePaymentMethodStatus || (exports.CommercePaymentMethodStatus = {}));
 /**
  * A Payment Method represents the payment method(s) used to make payments.
  *

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

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

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

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

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

@@ -1,5 +1,6 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { ProductVariant } from "./productvariant";
+import { SupplementalData } from "./supplementaldata";
 /**
  * A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale.
  *
@@ -10,7 +11,7 @@ import { ProductVariant } from "./productvariant";
  */
 export declare class CommerceProduct extends SpeakeasyBase {
     /**
-     * Retail category that the product is assigned to
+     * Retail category that the product is assigned to e.g. `Hardware`.
      */
     categorization?: string;
     /**
@@ -25,7 +26,7 @@ export declare class CommerceProduct extends SpeakeasyBase {
      * Whether the product represents a gift card or voucher that
      *
      * @remarks
-     * can be redeemed in the commerce or POS platform
+     * can be redeemed in the commerce or POS platform.
      *
      */
     isGiftCard?: boolean;
@@ -33,5 +34,13 @@ export declare class CommerceProduct extends SpeakeasyBase {
      * Name of the product in the commerce or POS system
      */
     name?: 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;
     variants?: ProductVariant[];
 }