@zeniai/client-epic-state 5.1.57-betaDI1 → 5.1.57-betaRD2

package/lib/view/common/recurringViewHelper.d.ts

@@ -1,6 +1,6 @@
 import { ZeniDate } from '../../zeniDayJS';
-export declare const toRecurringFrequency: (v: string) => "daily" | "weekly" | "biweekly" | "monthly" | "quarterly" | "semi_weekly";
-export declare const toRecurringFrequencyStrict: (v?: string) => "daily" | "weekly" | "biweekly" | "monthly" | "quarterly" | "semi_weekly" | undefined;
+export declare const toRecurringFrequency: (v: string) => "weekly" | "biweekly" | "monthly" | "quarterly" | "daily" | "semi_weekly";
+export declare const toRecurringFrequencyStrict: (v?: string) => "weekly" | "biweekly" | "monthly" | "quarterly" | "daily" | "semi_weekly" | undefined;
 export type RecurringFrequencyType = NonNullable<ReturnType<typeof toRecurringFrequency>>;
 export declare const SEMI_WEEKLY_REQUIRED_DAYS_COUNT = 2;
 declare const toRecurringDatePickerOptions: (v: string) => "date" | "recurringCount";

package/lib/view/expenseAutomationView/epics/jeSchedule/fetchJeSchedulesEpic.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchJeSchedulesEpic = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const formatZeniDateFY_1 = require("../../../../commonStateTypes/fiscalYearHelpers/formatZeniDateFY");
 const timePeriod_1 = require("../../../../commonStateTypes/timePeriod");
 const jeSchedulesReducer_1 = require("../../../../entity/jeSchedules/jeSchedulesReducer");
 const tenantSelector_1 = require("../../../../entity/tenant/tenantSelector");
 const responsePayload_1 = require("../../../../responsePayload");
+const zeniDayJS_1 = require("../../../../zeniDayJS");
 const jeSchedulesViewReducer_1 = require("../../reducers/jeSchedulesViewReducer");
 const fetchJeSchedulesEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(jeSchedulesViewReducer_1.fetchJeSchedules.match), (0, operators_1.mergeMap)((action) => {
     const state = state$.value;
@@ -14,9 +16,20 @@ const fetchJeSchedulesEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, op
     const { period, refreshViewInBackground } = action.payload;
     const currentTenant = (0, tenantSelector_1.getCurrentTenant)(state);
     const selectedPeriod = selectedPeriodByTenantId[currentTenant.tenantId];
+    const isClosePeriodTab = state.expenseAutomationJESchedulesViewState.uiState.selectedPageTab ===
+        'schedules';
+    const existingEndDate = (0, timePeriod_1.toAbsoluteDay)((0, zeniDayJS_1.date)((0, timePeriod_1.toString)(period.start))
+        .subtract(1, 'month')
+        .endOf('month')
+        .format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT));
     const queryParam = {
         start_date: (0, timePeriod_1.toString)(period.start),
-        end_date: (0, timePeriod_1.toString)(period.end),
+        end_date: isClosePeriodTab || existingEndDate == null
+            ? (0, timePeriod_1.toString)(period.end)
+            : (0, timePeriod_1.toString)(existingEndDate),
+        ...(isClosePeriodTab
+            ? { close_period_start_date: (0, timePeriod_1.toString)(period.start) }
+            : {}),
     };
     return zeniAPI
         .getJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/expenses_automation/je_schedules?query=${encodeURIComponent(JSON.stringify(queryParam))}`)

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/initializeNewScheduleEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../../reducer';
+import { fetchAccountList } from '../../../../accountList/accountListReducer';
+import { fetchClassList } from '../../../../classList/classListReducer';
+import { clearSearchTransactionsForNewSchedule, initializeNewSchedule, resetNewScheduleLocalData } from '../../../reducers/jeSchedulesViewReducer';
+export type ActionType = ReturnType<typeof clearSearchTransactionsForNewSchedule> | ReturnType<typeof fetchAccountList> | ReturnType<typeof fetchClassList> | ReturnType<typeof initializeNewSchedule> | ReturnType<typeof resetNewScheduleLocalData>;
+export declare const initializeNewScheduleEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/initializeNewScheduleEpic.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeNewScheduleEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const accountListReducer_1 = require("../../../../accountList/accountListReducer");
+const classListReducer_1 = require("../../../../classList/classListReducer");
+const scheduleListHelper_1 = require("../../../../scheduleView/scheduleListView/scheduleListHelper");
+const jeSchedulesViewReducer_1 = require("../../../reducers/jeSchedulesViewReducer");
+const initializeNewScheduleEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(jeSchedulesViewReducer_1.initializeNewSchedule.match), (0, operators_1.mergeMap)((action) => {
+    const newScheduleActions = [];
+    const accountType = (0, scheduleListHelper_1.getAccountsTypesForScheduleEpics)();
+    const { accountListState, classListState } = state$.value;
+    if (accountListState.byReportId[accountType.accountListKey]?.fetchState ===
+        'Not-Started') {
+        newScheduleActions.push((0, accountListReducer_1.fetchAccountList)(accountType.accountListKey, true, false, false, false, accountType.allowedAccountList));
+    }
+    if (classListState.fetchState === 'Not-Started') {
+        newScheduleActions.push((0, classListReducer_1.fetchClassList)());
+    }
+    newScheduleActions.push((0, jeSchedulesViewReducer_1.resetNewScheduleLocalData)({ scheduleType: action.payload.scheduleType }));
+    newScheduleActions.push((0, jeSchedulesViewReducer_1.clearSearchTransactionsForNewSchedule)());
+    return (0, rxjs_1.from)(newScheduleActions);
+}));
+exports.initializeNewScheduleEpic = initializeNewScheduleEpic;

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/saveNewScheduleEpic.d.ts

@@ -0,0 +1,45 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { updateJESchedules, updateJESchedulesDetails } from '../../../../../entity/jeSchedules/jeSchedulesReducer';
+import { openSnackbar } from '../../../../../entity/snackbar/snackbarReducer';
+import { RootState } from '../../../../../reducer';
+import { ZeniAPI } from '../../../../../zeniAPI';
+import { resetNewScheduleLocalData, saveNewSchedule, saveNewScheduleFailure, saveNewScheduleSuccess } from '../../../reducers/jeSchedulesViewReducer';
+export type ActionType = ReturnType<typeof saveNewSchedule> | ReturnType<typeof saveNewScheduleSuccess> | ReturnType<typeof saveNewScheduleFailure> | ReturnType<typeof updateJESchedules> | ReturnType<typeof updateJESchedulesDetails> | ReturnType<typeof resetNewScheduleLocalData> | ReturnType<typeof openSnackbar>;
+export declare const saveNewScheduleEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => import("rxjs").Observable<{
+    payload: {
+        messageSection: import("../../../../..").SnackbarMessageSections;
+        messageText: import("../../../../..").SnackbarMessageSectionTexts;
+        type: import("../../../../..").SnackbarMessageType;
+        showStatusIcon?: boolean;
+        variables?: {
+            variableName: string;
+            variableValue: string;
+        }[];
+    };
+    type: "snackbar/openSnackbar";
+} | {
+    payload: {
+        jeSchedulesTransactionsPayload: import("../../../../../entity/jeSchedules/jeSchedulesPayload").JEScheduledTransactionPayload[];
+    };
+    type: "jeSchedules/updateJESchedules";
+} | {
+    payload: {
+        jeSchedulesPayload: import("../../../../../entity/jeSchedules/jeSchedulesPayload").JEScheduledTransactionPayload[];
+        scheduledJEntriesPayload: import("../../../../../entity/jeSchedules/jeSchedulesPayload").ScheduledJournalEntryPayload[] | undefined;
+        updateType: import("../../../../..").UpdateType;
+    };
+    type: "jeSchedules/updateJESchedulesDetails";
+} | {
+    payload: {
+        scheduleType: "prepaid_expenses" | "fixed_assets";
+    };
+    type: "expenseAutomationJESchedulesView/resetNewScheduleLocalData";
+} | {
+    payload: undefined;
+    type: "expenseAutomationJESchedulesView/saveNewScheduleSuccess";
+} | {
+    payload: {
+        status: import("../../../../../responsePayload").ZeniAPIStatus;
+    };
+    type: "expenseAutomationJESchedulesView/saveNewScheduleFailure";
+}>;

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/saveNewScheduleEpic.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveNewScheduleEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const jeSchedulesReducer_1 = require("../../../../../entity/jeSchedules/jeSchedulesReducer");
+const snackbarReducer_1 = require("../../../../../entity/snackbar/snackbarReducer");
+const transactionSelector_1 = require("../../../../../entity/transaction/transactionSelector");
+const responsePayload_1 = require("../../../../../responsePayload");
+const newScheduleLocalDataHelper_1 = require("../../../helpers/newScheduleLocalDataHelper");
+const jeSchedulesViewReducer_1 = require("../../../reducers/jeSchedulesViewReducer");
+const FAILURE_REASON_MESSAGES = {
+    multi_line_not_supported: 'This transaction has multiple lines and cannot be scheduled yet.',
+    missing_third_party_id: 'This transaction is missing a QuickBooks reference and cannot be scheduled.',
+    missing_vendor: 'Select a vendor before saving this schedule.',
+};
+const saveNewScheduleEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(jeSchedulesViewReducer_1.saveNewSchedule.match), (0, operators_1.mergeMap)((action) => {
+    const { scheduleType } = action.payload;
+    const state = state$.value;
+    const localData = state.expenseAutomationJESchedulesViewState.newSchedule
+        .newScheduleState[scheduleType];
+    const transactionId = localData.selectedBaseTransactionId?.id;
+    const transaction = transactionId != null
+        ? (0, transactionSelector_1.getSupportedTransactionById)(state.transactionState, transactionId)
+        : undefined;
+    if (transaction == null) {
+        return (0, rxjs_1.from)([
+            (0, jeSchedulesViewReducer_1.saveNewScheduleFailure)({
+                status: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'No base transaction selected for this schedule.'),
+            }),
+            (0, snackbarReducer_1.openSnackbar)({
+                messageSection: 'create_schedule',
+                messageText: 'failed',
+                type: 'error',
+                variables: [
+                    {
+                        variableName: '_api-error_',
+                        variableValue: 'No base transaction selected.',
+                    },
+                ],
+            }),
+        ]);
+    }
+    const result = (0, newScheduleLocalDataHelper_1.prepareNewSchedulePayload)(transaction, localData, scheduleType);
+    if (!result.ok) {
+        const message = FAILURE_REASON_MESSAGES[result.reason];
+        return (0, rxjs_1.from)([
+            (0, jeSchedulesViewReducer_1.saveNewScheduleFailure)({
+                status: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', message),
+            }),
+            (0, snackbarReducer_1.openSnackbar)({
+                messageSection: 'create_schedule',
+                messageText: 'failed',
+                type: 'error',
+                variables: [{ variableName: '_api-error_', variableValue: message }],
+            }),
+        ]);
+    }
+    const vendorName = localData.selectedVendor?.name ?? transaction.vendorName ?? '';
+    const queryParam = {
+        je_schedule_type: scheduleType,
+    };
+    const payload = { ...result.payload };
+    return zeniAPI
+        .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/schedules?query=${encodeURIComponent(JSON.stringify(queryParam))}`, payload)
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return (0, rxjs_1.from)([
+                (0, jeSchedulesReducer_1.updateJESchedules)(response.data.je_schedules),
+                (0, jeSchedulesReducer_1.updateJESchedulesDetails)(response.data.je_schedules, response.data.scheduled_journal_entries),
+                (0, jeSchedulesViewReducer_1.resetNewScheduleLocalData)({ scheduleType }),
+                (0, jeSchedulesViewReducer_1.saveNewScheduleSuccess)(),
+                (0, snackbarReducer_1.openSnackbar)({
+                    messageSection: 'create_schedule',
+                    messageText: 'success',
+                    type: 'success',
+                    variables: [
+                        { variableName: '_vendor_name_', variableValue: vendorName },
+                    ],
+                }),
+            ]);
+        }
+        return (0, rxjs_1.from)([
+            (0, jeSchedulesViewReducer_1.saveNewScheduleFailure)({ status: response.status }),
+            (0, snackbarReducer_1.openSnackbar)({
+                messageSection: 'create_schedule',
+                messageText: 'failed',
+                type: 'error',
+                variables: [
+                    {
+                        variableName: '_api-error_',
+                        variableValue: response.status.message,
+                    },
+                ],
+            }),
+        ]);
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.from)([
+        (0, snackbarReducer_1.openSnackbar)({
+            messageSection: 'create_schedule',
+            messageText: 'failed',
+            type: 'error',
+            variables: [
+                {
+                    variableName: '_api-error_',
+                    variableValue: JSON.stringify(error),
+                },
+            ],
+        }),
+        (0, jeSchedulesViewReducer_1.saveNewScheduleFailure)({
+            status: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', `Save New Schedule REST API call errored out ${JSON.stringify(error)}`),
+        }),
+    ])));
+}));
+exports.saveNewScheduleEpic = saveNewScheduleEpic;

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/searchTransactionsForNewScheduleEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateTransactions } from '../../../../../entity/transaction/transactionReducer';
+import { RootState } from '../../../../../reducer';
+import { ZeniAPI } from '../../../../../zeniAPI';
+import { searchTransactionsForNewSchedule, searchTransactionsForNewScheduleFailure, searchTransactionsForNewScheduleSuccess } from '../../../reducers/jeSchedulesViewReducer';
+export type ActionType = ReturnType<typeof searchTransactionsForNewSchedule> | ReturnType<typeof searchTransactionsForNewScheduleSuccess> | ReturnType<typeof searchTransactionsForNewScheduleFailure> | ReturnType<typeof updateTransactions>;
+export declare const searchTransactionsForNewScheduleEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/expenseAutomationView/epics/jeSchedule/newSchedule/searchTransactionsForNewScheduleEpic.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchTransactionsForNewScheduleEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const transactionReducer_1 = require("../../../../../entity/transaction/transactionReducer");
+const responsePayload_1 = require("../../../../../responsePayload");
+const jeSchedulesViewReducer_1 = require("../../../reducers/jeSchedulesViewReducer");
+const completedSubTab_1 = require("../../../types/completedSubTab");
+const jeSchedulesViewState_1 = require("../../../types/jeSchedulesViewState");
+const transactionsViewState_1 = require("../../../types/transactionsViewState");
+/** Dropdown-sized result set — no pagination for Base Transaction search. */
+const NEW_SCHEDULE_SEARCH_PAGE_SIZE = 10;
+const searchTransactionsForNewScheduleEpic = (actions$, _state$, zeniAPI) => {
+    const searchActions$ = actions$.pipe((0, operators_1.filter)(jeSchedulesViewReducer_1.searchTransactionsForNewSchedule.match));
+    /** No API for empty or 1-char queries; immediate merge so switchMap cancels any in-flight HTTP. */
+    const newSearchTooShortOrClear$ = searchActions$.pipe((0, operators_1.filter)((action) => action.payload.query.trim().length < jeSchedulesViewState_1.MIN_NEW_SCHEDULE_SEARCH_LENGTH));
+    const newSearchDebounced$ = searchActions$.pipe((0, operators_1.filter)((action) => action.payload.query.trim().length >= jeSchedulesViewState_1.MIN_NEW_SCHEDULE_SEARCH_LENGTH), (0, operators_1.debounceTime)(300));
+    return (0, rxjs_1.merge)(newSearchTooShortOrClear$, newSearchDebounced$).pipe((0, operators_1.switchMap)((action) => {
+        const query = action.payload.query.trim();
+        if (query.length < jeSchedulesViewState_1.MIN_NEW_SCHEDULE_SEARCH_LENGTH) {
+            return rxjs_1.EMPTY;
+        }
+        const queryParam = {
+            start_date: null,
+            end_date: null,
+            auto_categorized: false,
+            sort_by: (0, transactionsViewState_1.toTransactionsSortKey)('date'),
+            sort_order: 'desc',
+            page_token: null,
+            page_size: NEW_SCHEDULE_SEARCH_PAGE_SIZE,
+            search_text: query,
+            sub_tab: completedSubTab_1.DEFAULT_COMPLETED_SUB_TAB,
+        };
+        return zeniAPI
+            .getJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/expense-automation/transactions?query=${encodeURIComponent(JSON.stringify(queryParam))}`)
+            .pipe((0, operators_1.mergeMap)((response) => {
+            if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+                const { transactions } = response.data;
+                const actionsOut = [
+                    (0, transactionReducer_1.updateTransactions)(transactions, (value) => value.transaction_id, 'merge'),
+                    (0, jeSchedulesViewReducer_1.searchTransactionsForNewScheduleSuccess)({
+                        searchResults: transactions.map((transaction) => transaction.transaction_id),
+                    }),
+                ];
+                return (0, rxjs_1.from)(actionsOut);
+            }
+            return (0, rxjs_1.of)((0, jeSchedulesViewReducer_1.searchTransactionsForNewScheduleFailure)({
+                status: response.status,
+            }));
+        }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, jeSchedulesViewReducer_1.searchTransactionsForNewScheduleFailure)({
+            status: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Search transactions for new schedule errored: ' +
+                JSON.stringify(error)),
+        }))));
+    }));
+};
+exports.searchTransactionsForNewScheduleEpic = searchTransactionsForNewScheduleEpic;

package/lib/view/expenseAutomationView/epics/jeSchedule/switchJESchedulesTabEpic.d.ts

@@ -0,0 +1,6 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../reducer';
+import { fetchJeSchedulesPage, updateJESchedulesUIState } from '../../reducers/jeSchedulesViewReducer';
+export type ActionType = ReturnType<typeof fetchJeSchedulesPage> | ReturnType<typeof updateJESchedulesUIState>;
+export declare const switchJESchedulesTabEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/expenseAutomationView/epics/jeSchedule/switchJESchedulesTabEpic.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.switchJESchedulesTabEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const timePeriod_1 = require("../../../../commonStateTypes/timePeriod");
+const tenantSelector_1 = require("../../../../entity/tenant/tenantSelector");
+const jeSchedulesViewReducer_1 = require("../../reducers/jeSchedulesViewReducer");
+const switchJESchedulesTabEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(jeSchedulesViewReducer_1.updateJESchedulesUIState.match), (0, operators_1.filter)((action) => action.payload.selectedPageTab != null), (0, operators_1.mergeMap)(() => {
+    const state = state$.value;
+    const { fetchState, refreshStatus } = state.expenseAutomationJESchedulesViewState;
+    if (fetchState === 'In-Progress' ||
+        refreshStatus.fetchState === 'In-Progress') {
+        return rxjs_1.EMPTY;
+    }
+    const currentTenant = (0, tenantSelector_1.getCurrentTenant)(state);
+    const selectedPeriod = state.expenseAutomationViewState.selectedPeriodByTenantId[currentTenant.tenantId];
+    const period = (0, timePeriod_1.convertToPeriod)(selectedPeriod);
+    const timePeriodStart = (0, timePeriod_1.toAbsoluteDay)(period.start);
+    const timePeriodEnd = (0, timePeriod_1.toAbsoluteDay)(period.end);
+    if (timePeriodStart == null || timePeriodEnd == null) {
+        return rxjs_1.EMPTY;
+    }
+    return (0, rxjs_1.of)((0, jeSchedulesViewReducer_1.fetchJeSchedulesPage)({ start: timePeriodStart, end: timePeriodEnd }, true));
+}));
+exports.switchJESchedulesTabEpic = switchJESchedulesTabEpic;

package/lib/view/expenseAutomationView/helpers/newScheduleLocalDataHelper.d.ts

@@ -0,0 +1,43 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ScheduleTypes } from '../../../entity/jeSchedules/jeSchedulesTypes';
+import { SupportedTransaction } from '../../../entity/transaction/transactionState';
+import { JESchedulePayload, SaveJESchedulePayload } from '../../scheduleView/scheduleDetailView/scheduleDetailPayload';
+import { NewJeDetailLocalData, NewScheduleLocalData, NewScheduleLocalDataFixedAssets } from '../types/jeSchedulesViewState';
+/**
+ * Computes the month-by-month JE schedule breakdown for a brand-new schedule
+ * (no linked transaction yet) — replicates createNewSchedulesHelper's math
+ * (scheduleDetailLocalDataHelper.ts) exactly: lump-sum total split evenly
+ * across months with the rounding remainder absorbed by the last month, and a
+ * running balance that decrements each month and is forced to exactly 0 on
+ * the last row.
+ */
+export declare const computeNewScheduleJeDetails: (localData: NewScheduleLocalData | NewScheduleLocalDataFixedAssets, totalAmount: Amount, vendorName: string) => NewJeDetailLocalData[];
+/**
+ * Whether a Base Transaction search result can be selected for a new
+ * schedule this round — restricted to single-line transactions since the
+ * search/list endpoint's `lines` may not reflect the transaction's full line
+ * set, and there is no line-picker UI yet.
+ */
+export declare const isSupportedTransactionSelectableForNewSchedule: (transaction: SupportedTransaction) => boolean;
+export interface NewSchedulePayload {
+    je_schedules: JESchedulePayload[];
+    scheduled_journal_entries: SaveJESchedulePayload[];
+}
+export type PrepareNewSchedulePayloadFailureReason = 'missing_third_party_id' | 'missing_vendor' | 'multi_line_not_supported';
+export type PrepareNewSchedulePayloadResult = {
+    ok: true;
+    payload: NewSchedulePayload;
+} | {
+    ok: false;
+    reason: PrepareNewSchedulePayloadFailureReason;
+};
+/**
+ * Builds a savable schedule payload directly from a Base Transaction search
+ * result and the New Schedule form's local data — bypassing the legacy
+ * getJEScheduledTransactionByJEScheduleTransactionKey selector entirely,
+ * since that selector throws unless the entity has already round-tripped
+ * through a real GET /1.0/schedules/:id. A brand-new schedule has no such
+ * history, so this reads only from data already in hand (the selected
+ * transaction/line plus what the user filled into the form).
+ */
+export declare const prepareNewSchedulePayload: (transaction: SupportedTransaction, localData: NewScheduleLocalData | NewScheduleLocalDataFixedAssets, scheduleType: ScheduleTypes) => PrepareNewSchedulePayloadResult;

package/lib/view/expenseAutomationView/helpers/newScheduleLocalDataHelper.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prepareNewSchedulePayload = exports.isSupportedTransactionSelectableForNewSchedule = exports.computeNewScheduleJeDetails = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const formatZeniDateFY_1 = require("../../../commonStateTypes/fiscalYearHelpers/formatZeniDateFY");
+const formatZeniDateFY_2 = require("../../../commonStateTypes/fiscalYearHelpers/formatZeniDateFY");
+const timePeriod_1 = require("../../../commonStateTypes/timePeriod");
+const scheduleTransactionHelper_1 = require("../../../entity/transaction/scheduleTransactionHelper");
+const scheduleDetailLocalDataHelper_1 = require("../../scheduleView/scheduleDetailView/scheduleDetailLocalDataHelper");
+const scheduleDetailPayload_1 = require("../../scheduleView/scheduleDetailView/scheduleDetailPayload");
+const getNewScheduleMemo = (vendorName, schedulePostingDate, currentPeriod, totalPeriod, assetId) => {
+    const addAsset = assetId != null && assetId !== '' ? ` - ${assetId}` : '';
+    return `${vendorName} - ${schedulePostingDate.format(formatZeniDateFY_2.MONTH_YEAR_FORMAT)} (${currentPeriod} of ${totalPeriod})${addAsset}`;
+};
+/**
+ * Computes the month-by-month JE schedule breakdown for a brand-new schedule
+ * (no linked transaction yet) — replicates createNewSchedulesHelper's math
+ * (scheduleDetailLocalDataHelper.ts) exactly: lump-sum total split evenly
+ * across months with the rounding remainder absorbed by the last month, and a
+ * running balance that decrements each month and is forced to exactly 0 on
+ * the last row.
+ */
+const computeNewScheduleJeDetails = (localData, totalAmount, vendorName) => {
+    const period = localData.selectedMonths;
+    const startingMonth = localData.selectedDate;
+    if (startingMonth == null || period == null) {
+        return [];
+    }
+    const assetId = 'assetId' in localData ? localData.assetId : undefined;
+    const averageAmount = Math.abs(Math.round((totalAmount.amount / period) * 100) / 100);
+    const lastMonthAmount = Math.abs(Math.round((Math.abs(totalAmount.amount) - averageAmount * (period - 1)) * 100) / 100);
+    let runningBalance = Math.abs(totalAmount.amount);
+    const negativeNumbers = totalAmount.amount < 0 || runningBalance < 0;
+    const newJeDetails = [];
+    for (let index = 0; index < period; index++) {
+        if (runningBalance > averageAmount) {
+            runningBalance = Math.round((runningBalance - averageAmount) * 100) / 100;
+        }
+        else {
+            runningBalance = 0;
+        }
+        const amount = index === period - 1 ? lastMonthAmount : averageAmount;
+        runningBalance = index === period - 1 ? 0 : runningBalance;
+        const schedulePostingDate = startingMonth.add(index, 'month');
+        const { postingDate, postingStatus } = (0, scheduleDetailLocalDataHelper_1.getPostingDateAndStatusForIndex)(schedulePostingDate.month(), schedulePostingDate.year(), localData.lastDayOfMonth === true
+            ? undefined
+            : localData.selectedDayOfMonth);
+        newJeDetails.push({
+            postingDate,
+            amount: (0, amount_1.toAmount)(negativeNumbers ? -amount : amount, totalAmount.currencyCode, totalAmount.currencySymbol),
+            runningBalance: (0, amount_1.toAmount)(negativeNumbers ? -runningBalance : runningBalance, totalAmount.currencyCode, totalAmount.currencySymbol),
+            postingStatus,
+            memo: getNewScheduleMemo(vendorName, schedulePostingDate, index + 1, period, assetId),
+            jeLink: { type: 'unknown' },
+        });
+    }
+    return newJeDetails;
+};
+exports.computeNewScheduleJeDetails = computeNewScheduleJeDetails;
+/**
+ * Whether a Base Transaction search result can be selected for a new
+ * schedule this round — restricted to single-line transactions since the
+ * search/list endpoint's `lines` may not reflect the transaction's full line
+ * set, and there is no line-picker UI yet.
+ */
+const isSupportedTransactionSelectableForNewSchedule = (transaction) => transaction.totalLinesCount === 1 && transaction.lines?.length === 1;
+exports.isSupportedTransactionSelectableForNewSchedule = isSupportedTransactionSelectableForNewSchedule;
+const mapNewJeDetailsToScheduledJournalEntryPayload = (jeScheduleDetails) => jeScheduleDetails.map((journalEntry) => ({
+    status: {
+        code: journalEntry.postingStatus,
+        label: journalEntry.postingStatus,
+    },
+    transaction_memo: journalEntry.memo,
+    third_party_id: journalEntry.jeLink.thirdPartyTransactionId ?? null,
+    expected_post_date: journalEntry.postingDate.format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT),
+    amount: journalEntry.amount.amount,
+    balance: journalEntry.runningBalance.amount,
+    // Brand-new schedule — there is no prior scheduled-journal-entry history
+    // to cross-reference (unlike the legacy edit flow's equivalent mapper).
+    scheduled_journal_entry_id: null,
+    actual_post_date: null,
+    is_platform_generated: null,
+    je_schedule_id: null,
+    update_time: null,
+    create_time: null,
+}));
+/**
+ * Builds a savable schedule payload directly from a Base Transaction search
+ * result and the New Schedule form's local data — bypassing the legacy
+ * getJEScheduledTransactionByJEScheduleTransactionKey selector entirely,
+ * since that selector throws unless the entity has already round-tripped
+ * through a real GET /1.0/schedules/:id. A brand-new schedule has no such
+ * history, so this reads only from data already in hand (the selected
+ * transaction/line plus what the user filled into the form).
+ */
+const prepareNewSchedulePayload = (transaction, localData, scheduleType) => {
+    const [firstLine] = transaction.lines ?? [];
+    if (!(0, exports.isSupportedTransactionSelectableForNewSchedule)(transaction) ||
+        firstLine == null) {
+        return { ok: false, reason: 'multi_line_not_supported' };
+    }
+    const scheduleTransaction = (0, scheduleTransactionHelper_1.mapSupportedTransactionLineToScheduleTransaction)(transaction, firstLine.id);
+    if (scheduleTransaction == null) {
+        return { ok: false, reason: 'missing_third_party_id' };
+    }
+    const vendorId = localData.selectedVendor?.id ?? transaction.vendorId ?? '';
+    const vendorName = localData.selectedVendor?.name ?? transaction.vendorName ?? '';
+    if (vendorId === '' || vendorName === '') {
+        return { ok: false, reason: 'missing_vendor' };
+    }
+    const vendor = {
+        vendor_id: vendorId,
+        vendor_name: vendorName,
+    };
+    const jeScheduleDetails = (0, exports.computeNewScheduleJeDetails)(localData, scheduleTransaction.amount, vendorName);
+    const postingDate = localData.selectedDayOfMonth ??
+        (localData.lastDayOfMonth === true ? timePeriod_1.LAST_SCHEDULE_DAY_OF_MONTH : null);
+    const firstJEScheduleDate = jeScheduleDetails.length > 0
+        ? jeScheduleDetails[0].postingDate.format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT)
+        : null;
+    const lastJEScheduleDate = jeScheduleDetails.length > 0
+        ? jeScheduleDetails[jeScheduleDetails.length - 1].postingDate.format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT)
+        : null;
+    const isFixedAssets = scheduleType === 'fixed_assets';
+    const assetId = 'assetId' in localData ? localData.assetId : undefined;
+    const selectedAccumulatedDepreciationCategory = 'selectedAccumulatedDepreciationCategory' in localData
+        ? localData.selectedAccumulatedDepreciationCategory
+        : undefined;
+    const status = { code: 'new', label: 'New' };
+    const jeSchedulePayload = {
+        status,
+        vendor,
+        currency_code: scheduleTransaction.currency.currencyCode,
+        currency_symbol: scheduleTransaction.currency.currencySymbol,
+        period: localData.selectedMonths ?? null,
+        je_schedule_type: scheduleType,
+        posting_date: postingDate,
+        balance: scheduleTransaction.amount.amount,
+        start_date: firstJEScheduleDate,
+        end_date: lastJEScheduleDate,
+        je_credit_accounting_class_id: scheduleTransaction.classBase?.classId ?? null,
+        je_credit_account_id: isFixedAssets
+            ? (selectedAccumulatedDepreciationCategory ?? null)
+            : scheduleTransaction.account.accountId,
+        je_debit_account_id: localData.selectedAccount ?? null,
+        je_debit_accounting_class_id: localData.selectedClass ?? null,
+        other_attributes: assetId != null ? { asset_id: assetId } : {},
+        base_transaction: (0, scheduleDetailPayload_1.mapScheduleTransactionToBaseScheduleTransactionPayload)(scheduleTransaction),
+    };
+    return {
+        ok: true,
+        payload: {
+            je_schedules: [jeSchedulePayload],
+            scheduled_journal_entries: mapNewJeDetailsToScheduledJournalEntryPayload(jeScheduleDetails),
+        },
+    };
+};
+exports.prepareNewSchedulePayload = prepareNewSchedulePayload;

package/lib/view/expenseAutomationView/payload/jeSchedulesPayload.d.ts

@@ -8,6 +8,7 @@ import { JEScheduleLocalData } from '../types/jeSchedulesViewState';
 export interface ExpenseAutomationJESchedulesQueryPayload {
     end_date: string;
     start_date: string;
+    close_period_start_date?: string;
 }
 interface ExpenseAutomationJESchedulesPayload {
     failed_je_postings: {