@zeniai/client-epic-state 4.11.60 → 4.11.62

package/lib/commonPayloadTypes/agingReportPayloadTypes.d.ts

@@ -0,0 +1,22 @@
+import { Currency } from '../commonStateTypes/amount';
+import { ID } from '../commonStateTypes/common';
+import { AgingReportInvoice } from '../commonStateTypes/viewAndReport/agingReportStateTypes';
+interface AgingAmountPayload {
+    value: number | null;
+    total_value?: number | null;
+}
+export interface AgingBalancePayload {
+    amount?: AgingAmountPayload;
+}
+export interface AgingInvoicePayload {
+    transaction_type: string;
+    days_past_due: number | null;
+    invoice_number: string | null;
+    due_date: string | null;
+    tx_date: string;
+    amount: number;
+    balance_due: number;
+    transaction_id: string;
+}
+export declare function toAgingReportInvoice(invoice: AgingInvoicePayload, entityId: ID, currency: Currency): AgingReportInvoice;
+export {};

package/lib/commonPayloadTypes/agingReportPayloadTypes.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toAgingReportInvoice = void 0;
+const transactionType_1 = require("../entity/transaction/stateTypes/transactionType");
+const zeniDayJS_1 = require("../zeniDayJS");
+function toAgingReportInvoice(invoice, entityId, currency) {
+    const result = {
+        invoiceNumber: invoice.invoice_number,
+        date: (0, zeniDayJS_1.date)(invoice.tx_date),
+        dueDate: invoice.due_date != null ? (0, zeniDayJS_1.date)(invoice.due_date) : null,
+        daysPastDue: invoice.days_past_due,
+        amount: {
+            amount: invoice.amount,
+            currencyCode: currency.currencyCode,
+            currencySymbol: currency.currencySymbol,
+        },
+        balance: {
+            amount: invoice.balance_due,
+            currencyCode: currency.currencyCode,
+            currencySymbol: currency.currencySymbol,
+        },
+        transactionId: invoice.transaction_id,
+        transactionType: (0, transactionType_1.toTransactionType)(invoice.transaction_type),
+        entityId,
+    };
+    return result;
+}
+exports.toAgingReportInvoice = toAgingReportInvoice;

package/lib/commonPayloadTypes/balanceChangePayload.d.ts

@@ -0,0 +1,20 @@
+import { Balance, BalanceChange } from '../commonStateTypes/balance';
+export interface BalanceChangePayload {
+    available?: number;
+    available_percent?: number;
+    current?: number;
+    current_percent?: number;
+    since: string;
+    percent?: number;
+    currency_symbol: string;
+    currency_code: string;
+}
+export interface BalancePayload {
+    available?: number | null;
+    forecast?: number | null;
+    currency_code: string;
+    currency_symbol: string;
+    change?: BalanceChangePayload;
+}
+export declare const mapBalancePayloadToBalance: (payload: BalancePayload) => Balance;
+export declare const mapBalanceChangePayloadToBalanceChange: (payload: BalanceChangePayload) => BalanceChange;

package/lib/commonPayloadTypes/balanceChangePayload.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapBalanceChangePayloadToBalanceChange = exports.mapBalancePayloadToBalance = void 0;
+const amount_1 = require("../commonStateTypes/amount");
+const zeniDayJS_1 = require("../zeniDayJS");
+const mapBalancePayloadToBalance = (payload) => {
+    var _a;
+    return ({
+        available: (0, amount_1.toAmount)((_a = payload.available) !== null && _a !== void 0 ? _a : 0, payload.currency_code, payload.currency_symbol),
+        change: payload.change
+            ? (0, exports.mapBalanceChangePayloadToBalanceChange)(payload.change)
+            : undefined,
+    });
+};
+exports.mapBalancePayloadToBalance = mapBalancePayloadToBalance;
+const mapBalanceChangePayloadToBalanceChange = (payload) => ({
+    available: payload.available != null
+        ? (0, amount_1.toAmount)(payload.available, payload.currency_code, payload.currency_symbol)
+        : undefined,
+    availablePercent: payload.available_percent,
+    since: (0, zeniDayJS_1.date)(payload.since),
+    percent: payload.percent,
+    current: payload.current == null
+        ? undefined
+        : (0, amount_1.toAmount)(payload.current, payload.currency_code, payload.currency_symbol),
+    currentPercent: payload.current_percent,
+});
+exports.mapBalanceChangePayloadToBalanceChange = mapBalanceChangePayloadToBalanceChange;

package/lib/commonPayloadTypes/classesView/reportByClassPayloadV2.d.ts

@@ -0,0 +1,28 @@
+import { NestedAccountIDHierarchy } from '../../commonStateTypes/accountView/nestedAccountID';
+import { NestedClassID } from '../../commonStateTypes/classesView/nestedClassID';
+import { AccountMetadataPayload } from '../../entity/account/accountPayload';
+import { ClassMetadataPayload } from '../../entity/class/classPayload';
+import { AccountCOABalanceGroupedPayloadByAccountId } from '../subAccountView/reportBySubAccountPayload';
+import { COABalanceGroupedPayloadV2 } from '../v2/coaBalancePayload';
+import { ReportPayloadV2 } from '../v2/viewAndReportPayloadv2';
+export interface ReportByClassMetadataPayloadV2 extends ReportPayloadV2 {
+    classes: ClassMetadataPayload[];
+    accounts: AccountMetadataPayload[];
+}
+export interface ClassAccountCOABalanceGroupedPayloadV2 extends COABalanceGroupedPayloadV2 {
+}
+export interface ClassCOABalanceGroupedPayloadV2 extends COABalanceGroupedPayloadV2 {
+    accounts: AccountCOABalanceGroupedPayloadByAccountId;
+}
+export interface ClassCOABalanceGroupedPayloadByClassIdV2 {
+    [class_Id: string]: ClassCOABalanceGroupedPayloadV2;
+}
+export interface SectionByClassCOABalanceGroupedPayloadV2 extends COABalanceGroupedPayloadV2 {
+    classes: ClassCOABalanceGroupedPayloadByClassIdV2;
+}
+export interface ClassMetadataWithBalancesPayloadV2 {
+    classMetadata: ClassMetadataPayload;
+    classBalances: ClassCOABalanceGroupedPayloadV2;
+    nestedClassId: NestedClassID;
+    nestedAccountIds: NestedAccountIDHierarchy[];
+}

package/lib/commonPayloadTypes/classesView/reportByClassPayloadV2.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ToDo:: Define this type individually for each report if platform is not supporting this.
+export interface PandLReportByClassPayload {
+  metadata: ReportByClassMetadataPayload;
+  sections: Record<string, SectionByClassCOABalanceGroupedPayload>; // Record<section_id, SectionCOABalanceGroupedPayload>
+  calculated_sections: Record<string, COABalanceGroupedByPeriodPayload>; // Record<calcualted_section_id, COABalanceGroupedByPeriodPayload>
+}
+*/

package/lib/commonPayloadTypes/coaBalanceByAdditionalPeriodPayload.d.ts

@@ -0,0 +1,7 @@
+import { COABalanceByAdditionalPeriodGrouped } from '../commonStateTypes/coaBalance/coaBalanceByAdditionalPeriod';
+import { COABalanceGroupedPayload, COABalancePayload } from './coaBalancePayload';
+export interface COABalanceByAdditionalPeriodGroupedPayload extends COABalanceGroupedPayload {
+    last_30_days_months: COABalancePayload[] | null;
+    last_90_days_months: COABalancePayload[] | null;
+}
+export declare const toCOABalanceByAdditionalPeriodGrouped: (payload: COABalanceByAdditionalPeriodGroupedPayload) => COABalanceByAdditionalPeriodGrouped;

package/lib/commonPayloadTypes/coaBalanceByAdditionalPeriodPayload.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCOABalanceByAdditionalPeriodGrouped = void 0;
+const coaBalancePayload_1 = require("./coaBalancePayload");
+const toCOABalanceByAdditionalPeriodGrouped = (payload) => (Object.assign(Object.assign({}, (0, coaBalancePayload_1.mapCOABalanceGroupedPayloadToCOABalanceGrouped)(payload)), { last30DaysMonths: payload.last_30_days_months != null
+        ? payload.last_30_days_months.map((p) => (0, coaBalancePayload_1.mapCOABalancePayloadToCOABalance)(p, 'month'))
+        : [], last90DaysMonths: payload.last_90_days_months != null
+        ? payload.last_90_days_months.map((p) => (0, coaBalancePayload_1.mapCOABalancePayloadToCOABalance)(p, 'month'))
+        : [] }));
+exports.toCOABalanceByAdditionalPeriodGrouped = toCOABalanceByAdditionalPeriodGrouped;

package/lib/commonPayloadTypes/coaBalancePayload.d.ts

@@ -0,0 +1,57 @@
+import { BalancePayload } from './balanceChangePayload';
+import { COABalanceTimeFrame, COABalance, COABalanceGrouped, COABalanceGroupedWithIDs, COABalanceGroupedWithAccountIDs, COABalanceWithAveragesGrouped, COABalanceGroupedByPeriod } from '../commonStateTypes/coaBalance/coaBalance';
+import { COABalanceType } from '../commonStateTypes/coaBalance/coaBalanceType';
+/**
+ * Interface for any Chart of Account (COA) balance payload in a
+ * date range.
+ */
+export interface COABalancePayload {
+    balance: BalancePayload;
+    start_date: string;
+    end_date: string;
+    id?: string;
+    label: string | null;
+    account_ids?: string[];
+}
+/**
+ * map COABalance Payload to COABalance
+ * @param payload COABalance payload JSON
+ * @param timeframe COABalance timeframe, default: 'free_range'
+ * @param type COABalance type, default: 'default'
+ * @returns COA Balance
+ */
+export declare const mapCOABalancePayloadToCOABalance: (payload: COABalancePayload, timeframe?: COABalanceTimeFrame, type?: COABalanceType) => COABalance;
+export interface COABalanceGroupedByPeriodPayload {
+    weeks?: COABalancePayload[];
+    months?: COABalancePayload[];
+    quarters?: COABalancePayload[];
+    years?: COABalancePayload[];
+}
+export interface COABalanceGroupedPayload extends COABalanceGroupedByPeriodPayload {
+    averages?: {
+        months?: COABalancePayload;
+    };
+    totals?: {
+        weeks?: COABalancePayload;
+        months?: COABalancePayload;
+        quarters?: COABalancePayload;
+        years?: COABalancePayload;
+    };
+}
+export interface COABalanceWithAveragesGroupedPayload extends COABalanceGroupedPayload {
+    averages?: {
+        months?: COABalancePayload;
+    };
+}
+export declare const mapCOABalanceGroupedPayloadToCOABalanceGrouped: (payload: COABalanceGroupedPayload) => COABalanceGrouped;
+export declare const mapCOABalanceGroupedWithAveragesPayloadToCOABalanceGrouped: (payload: COABalanceWithAveragesGroupedPayload) => COABalanceWithAveragesGrouped;
+export interface COABalanceGroupedWithIDsPayload extends COABalanceGroupedPayload {
+    account_group_ids?: string[];
+    account_ids?: string[];
+}
+export declare const mapCOABalanceGroupedWithIDsPayloadToCOABalanceGroupedWithIDs: (payload: COABalanceGroupedWithIDsPayload) => COABalanceGroupedWithIDs;
+export interface COABalanceGroupedWithAccountIDsPayload extends COABalanceGroupedPayload {
+    account_ids: string[];
+}
+export declare const mapCOABalanceGroupedWithAccountIDsPayloadToCOABalanceGroupedWithAccountIDs: (payload: COABalanceGroupedWithAccountIDsPayload) => COABalanceGroupedWithAccountIDs;
+export declare const mapCOABalanceGroupedByPeriodPayloadToCOABalanceGroupedByPeriod: (payload: COABalanceGroupedByPeriodPayload, timeframe: 'month' | 'quarter' | 'year') => COABalanceGroupedByPeriod;

package/lib/commonPayloadTypes/coaBalancePayload.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapCOABalanceGroupedByPeriodPayloadToCOABalanceGroupedByPeriod = exports.mapCOABalanceGroupedWithAccountIDsPayloadToCOABalanceGroupedWithAccountIDs = exports.mapCOABalanceGroupedWithIDsPayloadToCOABalanceGroupedWithIDs = exports.mapCOABalanceGroupedWithAveragesPayloadToCOABalanceGrouped = exports.mapCOABalanceGroupedPayloadToCOABalanceGrouped = exports.mapCOABalancePayloadToCOABalance = void 0;
+const amount_1 = require("../commonStateTypes/amount");
+const zeniDayJS_1 = require("../zeniDayJS");
+/**
+ * map COABalance Payload to COABalance
+ * @param payload COABalance payload JSON
+ * @param timeframe COABalance timeframe, default: 'free_range'
+ * @param type COABalance type, default: 'default'
+ * @returns COA Balance
+ */
+const mapCOABalancePayloadToCOABalance = (payload, timeframe = 'free_range', type = 'default') => {
+    var _a, _b, _c;
+    return {
+        balance: (0, amount_1.toAmount)((_a = payload.balance.available) !== null && _a !== void 0 ? _a : 0, payload.balance.currency_code, payload.balance.currency_symbol),
+        forecast: 'forecast' in payload.balance
+            ? (0, amount_1.toAmount)((_b = payload.balance.forecast) !== null && _b !== void 0 ? _b : 0, payload.balance.currency_code, payload.balance.currency_symbol)
+            : undefined,
+        balanceTimeFrame: timeframe,
+        type: type,
+        startDate: (0, zeniDayJS_1.date)(payload.start_date),
+        endDate: (0, zeniDayJS_1.date)(payload.end_date),
+        id: payload.id,
+        label: (_c = payload.label) !== null && _c !== void 0 ? _c : '',
+        sourceAccountIDs: payload.account_ids,
+    };
+};
+exports.mapCOABalancePayloadToCOABalance = mapCOABalancePayloadToCOABalance;
+const mapCOABalanceGroupedPayloadToCOABalanceGrouped = (payload) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    return ({
+        weeks: (_a = payload.weeks) === null || _a === void 0 ? void 0 : _a.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'week')),
+        months: (_b = payload.months) === null || _b === void 0 ? void 0 : _b.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'month')),
+        quarters: (_c = payload.quarters) === null || _c === void 0 ? void 0 : _c.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'quarter')),
+        years: (_d = payload === null || payload === void 0 ? void 0 : payload.years) === null || _d === void 0 ? void 0 : _d.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'year')),
+        totals: {
+            weeks: ((_e = payload.totals) === null || _e === void 0 ? void 0 : _e.weeks) == null ||
+                Object.keys((_f = payload.totals) === null || _f === void 0 ? void 0 : _f.weeks).length === 0
+                ? undefined
+                : (0, exports.mapCOABalancePayloadToCOABalance)(payload.totals.weeks),
+            months: ((_g = payload.totals) === null || _g === void 0 ? void 0 : _g.months) == null ||
+                Object.keys((_h = payload.totals) === null || _h === void 0 ? void 0 : _h.months).length === 0
+                ? undefined
+                : (0, exports.mapCOABalancePayloadToCOABalance)(payload.totals.months),
+            quarters: ((_j = payload.totals) === null || _j === void 0 ? void 0 : _j.quarters) == null ||
+                Object.keys((_k = payload.totals) === null || _k === void 0 ? void 0 : _k.quarters).length === 0
+                ? undefined
+                : (0, exports.mapCOABalancePayloadToCOABalance)(payload.totals.quarters),
+            years: ((_l = payload.totals) === null || _l === void 0 ? void 0 : _l.years) == null ||
+                Object.keys((_m = payload.totals) === null || _m === void 0 ? void 0 : _m.years).length === 0
+                ? undefined
+                : (0, exports.mapCOABalancePayloadToCOABalance)(payload.totals.years),
+        },
+    });
+};
+exports.mapCOABalanceGroupedPayloadToCOABalanceGrouped = mapCOABalanceGroupedPayloadToCOABalanceGrouped;
+const mapCOABalanceGroupedWithAveragesPayloadToCOABalanceGrouped = (payload) => {
+    const { averages } = Object.assign({}, payload);
+    const response = (0, exports.mapCOABalanceGroupedPayloadToCOABalanceGrouped)(payload);
+    return Object.assign(Object.assign({}, response), { averages: {
+            months: (averages === null || averages === void 0 ? void 0 : averages.months) == null || !Object.keys(averages === null || averages === void 0 ? void 0 : averages.months).length
+                ? undefined
+                : (0, exports.mapCOABalancePayloadToCOABalance)(averages.months),
+        } });
+};
+exports.mapCOABalanceGroupedWithAveragesPayloadToCOABalanceGrouped = mapCOABalanceGroupedWithAveragesPayloadToCOABalanceGrouped;
+const mapCOABalanceGroupedWithIDsPayloadToCOABalanceGroupedWithIDs = (payload) => {
+    var _a, _b;
+    return (Object.assign({ accountGroupIDs: (_a = payload.account_group_ids) !== null && _a !== void 0 ? _a : [], accountIDs: (_b = payload.account_ids) !== null && _b !== void 0 ? _b : [] }, (0, exports.mapCOABalanceGroupedPayloadToCOABalanceGrouped)(payload)));
+};
+exports.mapCOABalanceGroupedWithIDsPayloadToCOABalanceGroupedWithIDs = mapCOABalanceGroupedWithIDsPayloadToCOABalanceGroupedWithIDs;
+const mapCOABalanceGroupedWithAccountIDsPayloadToCOABalanceGroupedWithAccountIDs = (payload) => (Object.assign({ accountIDs: payload.account_ids }, (0, exports.mapCOABalanceGroupedPayloadToCOABalanceGrouped)(payload)));
+exports.mapCOABalanceGroupedWithAccountIDsPayloadToCOABalanceGroupedWithAccountIDs = mapCOABalanceGroupedWithAccountIDsPayloadToCOABalanceGroupedWithAccountIDs;
+const mapCOABalanceGroupedByPeriodPayloadToCOABalanceGroupedByPeriod = (payload, timeframe) => {
+    var _a, _b, _c;
+    switch (timeframe) {
+        case 'month':
+            return {
+                months: (_a = payload.months) === null || _a === void 0 ? void 0 : _a.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'month')),
+            };
+        case 'quarter':
+            return {
+                quarters: (_b = payload.quarters) === null || _b === void 0 ? void 0 : _b.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'quarter')),
+            };
+        case 'year':
+            return {
+                years: (_c = payload.years) === null || _c === void 0 ? void 0 : _c.map((p) => (0, exports.mapCOABalancePayloadToCOABalance)(p, 'year')),
+            };
+    }
+};
+exports.mapCOABalanceGroupedByPeriodPayloadToCOABalanceGroupedByPeriod = mapCOABalanceGroupedByPeriodPayloadToCOABalanceGroupedByPeriod;

package/lib/commonPayloadTypes/commonPayload.d.ts

@@ -0,0 +1,12 @@
+import { AllowedValueWithCode } from '../commonStateTypes/allowedValue';
+export interface AllowedValueWithCodePayload {
+    code: string;
+    name: string;
+}
+export interface AllowedValueWithCodeOptionalPayload {
+    code: string | null;
+    name: string | null;
+}
+export declare function isAllowedValueWithCodePayload(allowedValueWithCodePayload: any): allowedValueWithCodePayload is AllowedValueWithCodePayload;
+export declare function isAllowedValueWithCodeOptionalPayload(allowedValueWithCodePayload: any): allowedValueWithCodePayload is AllowedValueWithCodeOptionalPayload;
+export declare function toAllowedValueWithCode(allowedValueWithCodePayload: AllowedValueWithCodePayload): AllowedValueWithCode;

package/lib/commonPayloadTypes/commonPayload.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toAllowedValueWithCode = exports.isAllowedValueWithCodeOptionalPayload = exports.isAllowedValueWithCodePayload = void 0;
+function isAllowedValueWithCodePayload(allowedValueWithCodePayload // eslint-disable-line @typescript-eslint/no-explicit-any
+) {
+    return (isAllowedValueWithCodeOptionalPayload(allowedValueWithCodePayload) &&
+        allowedValueWithCodePayload.code != null &&
+        allowedValueWithCodePayload.name != null);
+}
+exports.isAllowedValueWithCodePayload = isAllowedValueWithCodePayload;
+function isAllowedValueWithCodeOptionalPayload(allowedValueWithCodePayload // eslint-disable-line @typescript-eslint/no-explicit-any
+) {
+    var _a, _b;
+    return (((_a = Object.keys(allowedValueWithCodePayload)) !== null && _a !== void 0 ? _a : []).includes('code') &&
+        ((_b = Object.keys(allowedValueWithCodePayload)) !== null && _b !== void 0 ? _b : []).includes('name'));
+}
+exports.isAllowedValueWithCodeOptionalPayload = isAllowedValueWithCodeOptionalPayload;
+// This helper is useful if we have any difference in AllowedValueWithCode from AllowedValueWithCodePayload
+function toAllowedValueWithCode(allowedValueWithCodePayload) {
+    return allowedValueWithCodePayload;
+}
+exports.toAllowedValueWithCode = toAllowedValueWithCode;

package/lib/commonPayloadTypes/recommendationPayload.d.ts

@@ -0,0 +1,24 @@
+import { Recommendation, RecommendationBase } from '../commonStateTypes/recommendationBase';
+import { RecommendedVendorBase } from '../commonStateTypes/vendorRecommendation';
+import { RecommendedAccountBasePayload } from '../entity/account/accountPayload';
+import { RecommendedClassBasePayload } from '../entity/class/classPayload';
+import { RecommendedVendorBasePayload } from './vendorRecommendationPayload';
+export interface RecommendationBasePayload {
+    min: number;
+    max?: number;
+    reason?: string;
+    type?: string;
+}
+export interface RecommendationPayload {
+    accounts?: RecommendedAccountBasePayload[];
+    accounting_classes?: RecommendedClassBasePayload[];
+    vendors?: RecommendedVendorBasePayload[];
+}
+export interface EntityRecommendationPayload {
+    account?: RecommendedAccountBasePayload;
+    accounting_class?: RecommendedClassBasePayload;
+}
+export declare const toRecommendationBase: (payload: RecommendationBasePayload) => RecommendationBase;
+export declare const toRecommendationBasePayload: (base: RecommendationBase) => RecommendationBasePayload;
+export declare const toRecommendationPayload: (recommendation: Recommendation) => EntityRecommendationPayload;
+export declare const toRecommendedVendorBasePayload: (vendorRecommendation: RecommendedVendorBase) => RecommendedVendorBasePayload;

package/lib/commonPayloadTypes/recommendationPayload.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toRecommendedVendorBasePayload = exports.toRecommendationPayload = exports.toRecommendationBasePayload = exports.toRecommendationBase = void 0;
+const accountPayload_1 = require("../entity/account/accountPayload");
+const classPayload_1 = require("../entity/class/classPayload");
+const toRecommendationBase = (payload) => {
+    var _a;
+    return {
+        max: payload.max,
+        min: payload.min,
+        reason: (_a = payload.reason) !== null && _a !== void 0 ? _a : '',
+        type: payload.type,
+    };
+};
+exports.toRecommendationBase = toRecommendationBase;
+const toRecommendationBasePayload = (base) => {
+    var _a, _b;
+    return {
+        max: base.max,
+        min: (_a = base.min) !== null && _a !== void 0 ? _a : 0,
+        reason: (_b = base.reason) !== null && _b !== void 0 ? _b : undefined,
+        type: base.type,
+    };
+};
+exports.toRecommendationBasePayload = toRecommendationBasePayload;
+const toRecommendationPayload = (recommendation) => {
+    return {
+        account: recommendation.account != null
+            ? (0, accountPayload_1.toRecommendedAccountBasePayload)(recommendation.account)
+            : undefined,
+        accounting_class: recommendation.class != null
+            ? (0, classPayload_1.toRecommendedClassBasePayload)(recommendation.class)
+            : undefined,
+    };
+};
+exports.toRecommendationPayload = toRecommendationPayload;
+const toRecommendedVendorBasePayload = (vendorRecommendation) => {
+    var _a, _b, _c, _d, _e;
+    return {
+        vendor_name: vendorRecommendation.name,
+        third_party_merchant_id: vendorRecommendation.thirdPartyMerchantId,
+        vendor_id: (_a = vendorRecommendation.id) !== null && _a !== void 0 ? _a : null,
+        qbo_id: (_b = vendorRecommendation.qboId) !== null && _b !== void 0 ? _b : null,
+        reason: vendorRecommendation.reason,
+        logo: {
+            url: (_c = vendorRecommendation.logo) === null || _c === void 0 ? void 0 : _c.toString(),
+            base64: null,
+        },
+        website_url: (_e = (_d = vendorRecommendation.websiteUrl) === null || _d === void 0 ? void 0 : _d.toString()) !== null && _e !== void 0 ? _e : null,
+    };
+};
+exports.toRecommendedVendorBasePayload = toRecommendedVendorBasePayload;

package/lib/commonPayloadTypes/sortOrderPayload.d.ts

@@ -0,0 +1,4 @@
+import { SortOrder } from '../commonStateTypes/selectorTypes/sortOrderTypes';
+export declare type SortOrderPayload = 'asc' | 'desc';
+export declare const mapSortOrderPayloadToSortOrder: (sortOrderPayload: SortOrderPayload) => SortOrder;
+export declare const getSortOrder: (sortOrder: SortOrder) => SortOrderPayload;

package/lib/commonPayloadTypes/sortOrderPayload.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSortOrder = exports.mapSortOrderPayloadToSortOrder = void 0;
+const mapSortOrderPayloadToSortOrder = (sortOrderPayload) => {
+    return sortOrderPayload === 'asc' ? 'ascending' : 'descending';
+};
+exports.mapSortOrderPayloadToSortOrder = mapSortOrderPayloadToSortOrder;
+const getSortOrder = (sortOrder) => {
+    return sortOrder === 'ascending' ? 'asc' : 'desc';
+};
+exports.getSortOrder = getSortOrder;

package/lib/commonPayloadTypes/statusPayload.d.ts

@@ -0,0 +1,14 @@
+import { Status } from '../commonStateTypes/status';
+export interface StatusCodeWithLabelPayload {
+    code: string;
+    label: string;
+}
+export interface StatusPayload {
+    code: number;
+    description: string;
+    message: string;
+    last_refresh_attempt_time?: string | null;
+    last_refresh_success_time?: string | null;
+    is_filtered_report?: boolean;
+}
+export declare const mapStatusPayloadToStatus: (payload: StatusPayload) => Status;

package/lib/commonPayloadTypes/statusPayload.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapStatusPayloadToStatus = void 0;
+const zeniDayJS_1 = require("../zeniDayJS");
+const mapStatusPayloadToStatus = (payload) => ({
+    code: payload.code,
+    description: payload.description,
+    message: payload.message,
+    lastRefreshAttemptTime: payload.last_refresh_attempt_time != null
+        ? (0, zeniDayJS_1.date)(payload.last_refresh_attempt_time)
+        : undefined,
+    lastRefreshSuccessTime: payload.last_refresh_success_time != null
+        ? (0, zeniDayJS_1.date)(payload.last_refresh_success_time)
+        : undefined,
+    isFilteredReport: payload.is_filtered_report,
+});
+exports.mapStatusPayloadToStatus = mapStatusPayloadToStatus;

package/lib/commonPayloadTypes/subAccountView/reportBySubAccountPayload.d.ts

@@ -0,0 +1,36 @@
+import { AccountsViewParentID, NestedAccountIDHierarchy } from '../../commonStateTypes/accountView/nestedAccountID';
+import { ClassesViewParentID } from '../../commonStateTypes/classesView/nestedClassID';
+import { AccountMetadataPayload } from '../../entity/account/accountPayload';
+import { AccountGroupMetadataPayload } from '../../entity/accountGroup/accountGroupPayload';
+import { COABalanceGroupedByPeriodPayloadV2, COABalanceGroupedPayloadV2 } from '../v2/coaBalancePayload';
+import { ReportPayloadV2 } from '../v2/viewAndReportPayloadv2';
+export interface ReportByAccountMetadataPayload extends ReportPayloadV2 {
+    account_groups: AccountGroupMetadataPayload[];
+    accounts: AccountMetadataPayload[];
+}
+export interface AccountCOABalanceGroupedPayload extends COABalanceGroupedPayloadV2 {
+}
+export interface AccountCOABalanceGroupedPayloadByAccountId {
+    [account_Id: string]: AccountCOABalanceGroupedPayload;
+}
+export interface AccountGroupCOABalanceGroupedPayload extends COABalanceGroupedByPeriodPayloadV2 {
+    accounts: AccountCOABalanceGroupedPayloadByAccountId;
+}
+export interface AccountGroupCOABalanceGroupedPayloadByAccountGroupId {
+    [account_group_id: string]: AccountGroupCOABalanceGroupedPayload;
+}
+export interface SectionByAccountGroupCOABalanceGroupedPayload extends COABalanceGroupedByPeriodPayloadV2 {
+    account_groups: AccountGroupCOABalanceGroupedPayloadByAccountGroupId;
+    accounts?: AccountCOABalanceGroupedPayloadByAccountId;
+}
+export interface AccountMetadataWithBalancesPayload {
+    accountMetadataPayload: AccountMetadataPayload;
+    accountBalancesPayload: AccountCOABalanceGroupedPayload;
+    accountsViewParentID?: AccountsViewParentID;
+    classesViewParentID?: ClassesViewParentID;
+}
+export interface AccountGroupMetadataWithBalancesPayload {
+    accountGroupMetadataPayload: AccountGroupMetadataPayload;
+    accountGroupBalances: COABalanceGroupedByPeriodPayloadV2;
+    nestedAccountIds: NestedAccountIDHierarchy[];
+}

package/lib/commonPayloadTypes/subAccountView/reportBySubAccountPayload.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commonPayloadTypes/subAccountView/subAccountPayloadHelper.d.ts

@@ -0,0 +1,5 @@
+import { AccountMetadataRecordsByID } from '../../commonStateTypes/accountView/nestedAccountID';
+import { ClassesViewParentID } from '../../commonStateTypes/classesView/nestedClassID';
+import { ID } from '../../commonStateTypes/common';
+import { AccountCOABalanceGroupedPayloadByAccountId, AccountMetadataWithBalancesPayload } from './reportBySubAccountPayload';
+export declare const getSubAccountsMetadataForAccountList: (accountListWithBalances: AccountCOABalanceGroupedPayloadByAccountId, accountMetadataRecordsByID: AccountMetadataRecordsByID, sectionId: ID, classesViewParentID?: ClassesViewParentID | undefined) => AccountMetadataWithBalancesPayload[];

package/lib/commonPayloadTypes/subAccountView/subAccountPayloadHelper.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSubAccountsMetadataForAccountList = void 0;
+const getNestedAccountIDHierarchyForReport_1 = require("../../commonStateTypes/accountView/getNestedAccountIDHierarchyForReport");
+const getSubAccountsMetadataForAccountList = (accountListWithBalances, accountMetadataRecordsByID, sectionId, classesViewParentID) => {
+    const accountMetadataWithBalances = [];
+    accountListWithBalances != null &&
+        Object.keys(accountListWithBalances).forEach((eachAccountId) => {
+            var _a;
+            const accountId = (_a = accountMetadataRecordsByID[eachAccountId]) === null || _a === void 0 ? void 0 : _a.nestedAccountId;
+            if (accountId != null) {
+                accountMetadataWithBalances.push({
+                    accountsViewParentID: {
+                        parentAccountId: (0, getNestedAccountIDHierarchyForReport_1.getParentAccountId)(accountId),
+                        sectionId,
+                    },
+                    accountMetadataPayload: accountMetadataRecordsByID[eachAccountId].accountMetadataPayload,
+                    accountBalancesPayload: accountListWithBalances[eachAccountId],
+                    classesViewParentID: classesViewParentID,
+                });
+            }
+            else {
+                console.warn(`Account ${eachAccountId} in Section ${sectionId} is missing metadata.`);
+            }
+        });
+    return accountMetadataWithBalances;
+};
+exports.getSubAccountsMetadataForAccountList = getSubAccountsMetadataForAccountList;

package/lib/commonPayloadTypes/urlPayload.d.ts

@@ -0,0 +1,6 @@
+import { ZeniUrl } from '../zeniUrl';
+export interface URLPayload {
+    url?: string | null;
+    base64?: string | null;
+}
+export declare const toURL: (urlPayload?: URLPayload | undefined) => ZeniUrl | undefined;

package/lib/commonPayloadTypes/urlPayload.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toURL = void 0;
+const zeniUrl_1 = require("../zeniUrl");
+const toURL = (urlPayload) => (urlPayload === null || urlPayload === void 0 ? void 0 : urlPayload.url) != null && (urlPayload === null || urlPayload === void 0 ? void 0 : urlPayload.url.length) !== 0
+    ? (0, zeniUrl_1.toZeniUrl)(urlPayload.url)
+    : undefined;
+exports.toURL = toURL;

package/lib/commonPayloadTypes/v2/coaBalancePayload.d.ts

@@ -0,0 +1,56 @@
+import { COABalance, COABalanceGrouped, COABalanceGroupedByPeriod, COABalanceTimeFrame } from '../../commonStateTypes/coaBalance/coaBalance';
+import { COABalanceType } from '../../commonStateTypes/coaBalance/coaBalanceType';
+import { CurrencyPayload } from './viewAndReportPayloadv2';
+export interface AmountPayloadV2 {
+    value: number | null;
+    total_value?: number | null;
+    forecast_value?: number | null;
+    total_forecast_value?: number | null;
+}
+/**
+ * Interface for any Chart of Account (COA) balance payload in a
+ * date range.
+ */
+export interface COABalancePayloadV2 {
+    amount: AmountPayloadV2;
+    start_date: string;
+    end_date: string;
+    id?: string;
+    label: string | null;
+    account_ids?: string[];
+}
+/**
+ * map COABalanceV2 Payload to COABalance
+ * @param payload COABalance payload JSON
+ * @param timeframe COABalance timeframe, default: 'free_range'
+ * @param type COABalance type, default: 'default'
+ * @returns COA Balance
+ */
+export declare const mapCOABalancePayloadV2ToCOABalance: (payload: COABalancePayloadV2, currencyPayload: CurrencyPayload, timeframe?: COABalanceTimeFrame, type?: COABalanceType) => COABalance;
+export interface COABalanceGroupedByPeriodPayloadV2 {
+    weeks?: COABalancePayloadV2[];
+    months?: COABalancePayloadV2[];
+    quarters?: COABalancePayloadV2[];
+    years?: COABalancePayloadV2[];
+}
+export interface COABalanceGroupedPayloadV2 extends COABalanceGroupedByPeriodPayloadV2 {
+    averages?: {
+        months?: COABalancePayloadV2;
+    };
+    totals?: {
+        weeks?: COABalancePayloadV2;
+        months?: COABalancePayloadV2;
+        quarters?: COABalancePayloadV2;
+        years?: COABalancePayloadV2;
+    };
+}
+export declare const mapCOABalanceGroupedPayloadV2ToCOABalanceGrouped: (payload: COABalanceGroupedPayloadV2, currencyPayload: CurrencyPayload, timeframe: 'month' | 'quarter' | 'year') => COABalanceGrouped;
+export declare const mapCOABalanceGroupedByPeriodPayloadV2ToCOABalanceGroupedByPeriod: (payload: COABalanceGroupedByPeriodPayloadV2, currencyPayload: CurrencyPayload, timeframe: 'month' | 'quarter' | 'year') => COABalanceGroupedByPeriod;
+/**
+ * Use this function to combine months/quarters/years coa payloads which
+ * also have totals in them
+ * @param payloadA
+ * @param payloadB
+ * @returns
+ */
+export declare const combineCOABalanceGrouped: (payloadA: COABalanceGrouped, payloadB: COABalanceGrouped) => COABalanceGrouped;