@codat/lending 3.2.0 → 3.3.0

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[];
 }

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

@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommerceProduct = void 0;
 var utils_1 = require("../../../internal/utils");
 var productvariant_1 = require("./productvariant");
+var supplementaldata_1 = require("./supplementaldata");
 var class_transformer_1 = require("class-transformer");
 /**
  * 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.
@@ -69,6 +70,12 @@ var CommerceProduct = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "name" }),
         __metadata("design:type", String)
     ], CommerceProduct.prototype, "name", 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)
+    ], CommerceProduct.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)({ elemType: productvariant_1.ProductVariant }),
         (0, class_transformer_1.Expose)({ name: "variants" }),

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

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

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

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

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

@@ -2,9 +2,21 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import { ReportComponentMeasure } from "./reportcomponentmeasure";
 export declare class CommerceReportComponent extends SpeakeasyBase {
     components?: CommerceReportComponent[];
+    /**
+     * The component's dimension.
+     */
     dimension?: number;
+    /**
+     * The component's display name.
+     */
     dimensionDisplayName?: string;
+    /**
+     * The component's item number.
+     */
     item?: number;
+    /**
+     * The component's item display name.
+     */
     itemDisplayName?: string;
     measures?: ReportComponentMeasure[];
 }

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

@@ -1,10 +1,22 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class CommerceReportDimensionItems extends SpeakeasyBase {
+    /**
+     * The dimension's items index.
+     */
     index?: number;
 }
 export declare class CommerceReportDimension extends SpeakeasyBase {
+    /**
+     * The dimension's display name.
+     */
     displayName?: string;
+    /**
+     * The dimension's index.
+     */
     index?: number;
     items?: CommerceReportDimensionItems[];
+    /**
+     * The dimension's type.
+     */
     type?: string;
 }

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

@@ -1,6 +1,15 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class CommerceReportError extends SpeakeasyBase {
+    /**
+     * Additional details on the error.
+     */
     details?: Record<string, string[]>;
+    /**
+     * Message returned by error.
+     */
     message?: string;
+    /**
+     * The type of error.
+     */
     type?: string;
 }

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

@@ -1,7 +1,19 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class CommerceReportMeasure extends SpeakeasyBase {
+    /**
+     * The measure's display name.
+     */
     displayName?: string;
+    /**
+     * The measure's index.
+     */
     index?: number;
+    /**
+     * The measure's type.
+     */
     type?: string;
+    /**
+     * The measure's units e.g. percentage (%).
+     */
     units?: string;
 }

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

@@ -1,4 +1,5 @@
 import { SpeakeasyBase } from "../../../internal/utils";
+import { SupplementalData } from "./supplementaldata";
 import { TransactionSourceRef } from "./transactionsourceref";
 import { TransactionType } from "./transactiontype";
 /**
@@ -86,6 +87,14 @@ export declare class CommerceTransaction extends SpeakeasyBase {
      * Non-standardised transaction type data from the commerce platform
      */
     subType?: 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;
     /**
      * The total transaction amount
      */

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

@@ -29,6 +29,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommerceTransaction = void 0;
 var utils_1 = require("../../../internal/utils");
+var supplementaldata_1 = require("./supplementaldata");
 var transactionsourceref_1 = require("./transactionsourceref");
 var transactiontype_1 = require("./transactiontype");
 var class_transformer_1 = require("class-transformer");
@@ -86,6 +87,12 @@ var CommerceTransaction = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "subType" }),
         __metadata("design:type", String)
     ], CommerceTransaction.prototype, "subType", 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)
+    ], CommerceTransaction.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "totalAmount" }),

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

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

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

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

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

@@ -34,6 +34,9 @@ export declare class Company 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.
      */
     created?: string;
+    /**
+     * Name of user that created the company in Codat.
+     */
     createdByUserName?: string;
     dataConnections?: Connection[];
     /**
@@ -73,6 +76,8 @@ export declare class Company extends SpeakeasyBase {
      */
     name: string;
     /**
+     * `platformKeys` name used when creating the company.
+     *
      * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     platform?: string;

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

@@ -89,7 +89,13 @@ export declare class Connection 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.
      */
     lastSync?: string;
+    /**
+     * The link URL your customers can use to authorize access to their business application.
+     */
     linkUrl: string;
+    /**
+     * Name of integration connected to company.
+     */
     platformName: string;
     /**
      * A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.

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

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

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

@@ -1,8 +1,15 @@
 import { SpeakeasyBase } from "../../../internal/utils";
+import { DataType } from "./datatype";
 /**
  * The customer or supplier for the transfer, if available.
  */
 export declare class ContactRef extends SpeakeasyBase {
-    dataType?: string;
+    /**
+     * Available Data types
+     */
+    dataType?: DataType;
+    /**
+     * Unique identifier for a customer or supplier.
+     */
     id: string;
 }

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

@@ -29,6 +29,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContactRef = void 0;
 var utils_1 = require("../../../internal/utils");
+var datatype_1 = require("./datatype");
 var class_transformer_1 = require("class-transformer");
 /**
  * The customer or supplier for the transfer, if available.

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

@@ -1,6 +1,12 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 export declare class CreateBankAccountTransaction extends SpeakeasyBase {
+    /**
+     * 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:
@@ -26,6 +32,12 @@ export declare class CreateBankAccountTransaction 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 of the bank transaction.
+     */
     description?: string;
+    /**
+     * Identifier for the bank account transaction, unique for the company in the accounting platform.
+     */
     id?: string;
 }

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

@@ -21,6 +21,9 @@ export declare class CreditNoteLineItem extends SpeakeasyBase {
      * Percentage rate of any discount applied to the line item.
      */
     discountPercentage?: number;
+    /**
+     * The credit note is a direct income if `True`.
+     */
     isDirectIncome?: boolean;
     /**
      * Reference to the item the line is linked to.

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

@@ -1,3 +1,6 @@
+/**
+ * Current state of the credit note.
+ */
 export declare enum CreditNoteStatus {
     Unknown = "Unknown",
     Draft = "Draft",