@codat/lending 4.2.0 → 4.3.0

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

@@ -1,18 +1,111 @@
 import { SpeakeasyBase } from "../../../internal/utils";
-import { AccountingDirectCost } from "./accountingdirectcost";
+import { AccountingPaymentAllocation } from "./accountingpaymentallocation";
 import { DataType } from "./datatype";
+import { DirectCostLineItem } from "./directcostlineitem";
+import { Metadata } from "./metadata";
 import { PushOperationChange } from "./pushoperationchange";
 import { PushOperationStatus } from "./pushoperationstatus";
+import { SupplementalData } from "./supplementaldata";
 import { Validation } from "./validation";
-export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
+/**
+ * Allowed name of the 'dataType'.
+ */
+export declare enum AccountingCreateDirectCostResponseDataType {
+    Customers = "customers",
+    Suppliers = "suppliers"
+}
+/**
+ * A customer or supplier associated with the direct cost.
+ */
+export declare class AccountingCreateDirectCostResponseContactReference extends SpeakeasyBase {
     /**
-     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     * Allowed name of the 'dataType'.
      */
-    changes?: PushOperationChange[];
+    dataType?: AccountingCreateDirectCostResponseDataType;
     /**
-     * Unique identifier for your SMB in Codat.
+     * Unique identifier for a customer or supplier.
      */
-    companyId: string;
+    id: string;
+}
+/**
+ * > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.
+ *
+ * @remarks
+ *
+ * > View the coverage for direct costs in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.
+ *
+ * Direct costs include:
+ *   * Purchasing an item and paying it off at the point of the purchase
+ *   * Receiving cash from a refunded item if the refund is made by the supplier
+ *   * Withdrawing money from a bank account
+ *   * Writing a cheque
+ *
+ * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export declare class AccountingCreateDirectCostResponseAccountingDirectCost extends SpeakeasyBase {
+    /**
+     * A customer or supplier associated with the direct cost.
+     */
+    contactRef?: AccountingCreateDirectCostResponseContactReference;
+    /**
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+     *
+     * @remarks
+     *
+     * ## Unknown currencies
+     *
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+     *
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+     */
+    currency: string;
+    /**
+     * Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.
+     *
+     * @remarks
+     *
+     * Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.
+     *
+     * It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.
+     *
+     * Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).
+     *
+     * For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.
+     *
+     * ## Examples with base currency of GBP
+     *
+     * | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |
+     * | :--------------- | :------------- | :------------ | :------------------------- |
+     * | **USD**          | $20            | 0.781         | £15.62                     |
+     * | **EUR**          | €20            | 0.885         | £17.70                     |
+     * | **RUB**          | ₽20            | 0.011         | £0.22                      |
+     *
+     * ## Examples with base currency of USD
+     *
+     * | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |
+     * | :--------------- | :------------- | :------------ | :------------------------- |
+     * | **GBP**          | £20            | 1.277         | $25.54                     |
+     * | **EUR**          | €20            | 1.134         | $22.68                     |
+     * | **RUB**          | ₽20            | 0.015         | $0.30                      |
+     *
+     *
+     * ### Integration-specific details
+     *
+     * | Integration       | Scenario                                        | System behavior                                                                                                                                                      |
+     * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+     * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction.  |
+     */
+    currencyRate?: number;
+    /**
+     * Identifier of the direct cost, unique for the company.
+     */
+    id?: 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:
      *
@@ -36,27 +129,81 @@ export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
      * > Not all dates from Codat will contain information about time zones.
      * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
-    completedOnUtc?: string;
+    issueDate: string;
+    /**
+     * An array of line items.
+     */
+    lineItems: DirectCostLineItem[];
+    metadata?: Metadata;
+    modifiedDate?: string;
+    /**
+     * A note attached to the direct cost.
+     */
+    note?: string;
+    /**
+     * An array of payment allocations.
+     */
+    paymentAllocations: AccountingPaymentAllocation[];
+    /**
+     * User-friendly reference for the direct cost.
+     */
+    reference?: string;
+    sourceModifiedDate?: string;
+    /**
+     * The total amount of the direct costs, excluding any taxes.
+     */
+    subTotal: number;
     /**
-     * > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.
+     * Supplemental data is additional data you can include in our standard data types.
      *
      * @remarks
      *
-     * > View the coverage for direct costs in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts" target="_blank">Data coverage explorer</a>.
+     * 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 amount of tax on the direct costs.
+     */
+    taxAmount: number;
+    /**
+     * The amount of the direct costs, inclusive of tax.
+     */
+    totalAmount: number;
+}
+export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
+    /**
+     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     */
+    changes?: PushOperationChange[];
+    /**
+     * Unique identifier for your SMB in Codat.
+     */
+    companyId: 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:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
      *
-     * ## Overview
      *
-     * Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.
      *
-     * Direct costs include:
-     *   * Purchasing an item and paying it off at the point of the purchase
-     *   * Receiving cash from a refunded item if the refund is made by the supplier
-     *   * Withdrawing money from a bank account
-     *   * Writing a cheque
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
      *
-     * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
-    data?: AccountingDirectCost;
+    completedOnUtc?: string;
+    data?: AccountingCreateDirectCostResponseAccountingDirectCost;
     /**
      * Unique identifier for a company's data connection.
      */

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

@@ -27,14 +27,160 @@ 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.AccountingCreateDirectCostResponse = void 0;
+exports.AccountingCreateDirectCostResponse = exports.AccountingCreateDirectCostResponseAccountingDirectCost = exports.AccountingCreateDirectCostResponseContactReference = exports.AccountingCreateDirectCostResponseDataType = void 0;
 var utils_1 = require("../../../internal/utils");
-var accountingdirectcost_1 = require("./accountingdirectcost");
+var accountingpaymentallocation_1 = require("./accountingpaymentallocation");
 var datatype_1 = require("./datatype");
+var directcostlineitem_1 = require("./directcostlineitem");
+var metadata_1 = require("./metadata");
 var pushoperationchange_1 = require("./pushoperationchange");
 var pushoperationstatus_1 = require("./pushoperationstatus");
+var supplementaldata_1 = require("./supplementaldata");
 var validation_1 = require("./validation");
 var class_transformer_1 = require("class-transformer");
+/**
+ * Allowed name of the 'dataType'.
+ */
+var AccountingCreateDirectCostResponseDataType;
+(function (AccountingCreateDirectCostResponseDataType) {
+    AccountingCreateDirectCostResponseDataType["Customers"] = "customers";
+    AccountingCreateDirectCostResponseDataType["Suppliers"] = "suppliers";
+})(AccountingCreateDirectCostResponseDataType = exports.AccountingCreateDirectCostResponseDataType || (exports.AccountingCreateDirectCostResponseDataType = {}));
+/**
+ * A customer or supplier associated with the direct cost.
+ */
+var AccountingCreateDirectCostResponseContactReference = /** @class */ (function (_super) {
+    __extends(AccountingCreateDirectCostResponseContactReference, _super);
+    function AccountingCreateDirectCostResponseContactReference() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dataType" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseContactReference.prototype, "dataType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseContactReference.prototype, "id", void 0);
+    return AccountingCreateDirectCostResponseContactReference;
+}(utils_1.SpeakeasyBase));
+exports.AccountingCreateDirectCostResponseContactReference = AccountingCreateDirectCostResponseContactReference;
+/**
+ * > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting platforms.
+ *
+ * @remarks
+ *
+ * > View the coverage for direct costs in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * Direct costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.
+ *
+ * Direct costs include:
+ *   * Purchasing an item and paying it off at the point of the purchase
+ *   * Receiving cash from a refunded item if the refund is made by the supplier
+ *   * Withdrawing money from a bank account
+ *   * Writing a cheque
+ *
+ * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+var AccountingCreateDirectCostResponseAccountingDirectCost = /** @class */ (function (_super) {
+    __extends(AccountingCreateDirectCostResponseAccountingDirectCost, _super);
+    function AccountingCreateDirectCostResponseAccountingDirectCost() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "contactRef" }),
+        (0, class_transformer_1.Type)(function () { return AccountingCreateDirectCostResponseContactReference; }),
+        __metadata("design:type", AccountingCreateDirectCostResponseContactReference)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "contactRef", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currency" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "currency", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currencyRate" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "currencyRate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "issueDate" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "issueDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: directcostlineitem_1.DirectCostLineItem }),
+        (0, class_transformer_1.Expose)({ name: "lineItems" }),
+        (0, class_transformer_1.Type)(function () { return directcostlineitem_1.DirectCostLineItem; }),
+        __metadata("design:type", Array)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "lineItems", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        (0, class_transformer_1.Type)(function () { return metadata_1.Metadata; }),
+        __metadata("design:type", metadata_1.Metadata)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "metadata", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "modifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "modifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "note" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "note", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: accountingpaymentallocation_1.AccountingPaymentAllocation }),
+        (0, class_transformer_1.Expose)({ name: "paymentAllocations" }),
+        (0, class_transformer_1.Type)(function () { return accountingpaymentallocation_1.AccountingPaymentAllocation; }),
+        __metadata("design:type", Array)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "paymentAllocations", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "reference" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "reference", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "sourceModifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "sourceModifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "subTotal" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "subTotal", 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)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "supplementalData", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "taxAmount" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "taxAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "totalAmount" }),
+        __metadata("design:type", Number)
+    ], AccountingCreateDirectCostResponseAccountingDirectCost.prototype, "totalAmount", void 0);
+    return AccountingCreateDirectCostResponseAccountingDirectCost;
+}(utils_1.SpeakeasyBase));
+exports.AccountingCreateDirectCostResponseAccountingDirectCost = AccountingCreateDirectCostResponseAccountingDirectCost;
 var AccountingCreateDirectCostResponse = /** @class */ (function (_super) {
     __extends(AccountingCreateDirectCostResponse, _super);
     function AccountingCreateDirectCostResponse() {
@@ -59,8 +205,8 @@ var AccountingCreateDirectCostResponse = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "data" }),
-        (0, class_transformer_1.Type)(function () { return accountingdirectcost_1.AccountingDirectCost; }),
-        __metadata("design:type", accountingdirectcost_1.AccountingDirectCost)
+        (0, class_transformer_1.Type)(function () { return AccountingCreateDirectCostResponseAccountingDirectCost; }),
+        __metadata("design:type", AccountingCreateDirectCostResponseAccountingDirectCost)
     ], AccountingCreateDirectCostResponse.prototype, "data", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),